This is an automated email from the ASF dual-hosted git repository.
jbertram pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/activemq-artemis.git
The following commit(s) were added to refs/heads/main by this push:
new a80d016306 ARTEMIS-5540 fix documentation
a80d016306 is described below
commit a80d016306e6045510456dbde9fd2ec5deb0dd78
Author: Evgeniy Devyatykh <[email protected]>
AuthorDate: Fri Jun 20 10:27:23 2025 +0500
ARTEMIS-5540 fix documentation
---
docs/user-manual/mqtt.adoc | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/docs/user-manual/mqtt.adoc b/docs/user-manual/mqtt.adoc
index 5cadbaa7cb..2c31583551 100644
--- a/docs/user-manual/mqtt.adoc
+++ b/docs/user-manual/mqtt.adoc
@@ -204,13 +204,14 @@ In the case of MQTT 5 clients they will receive a
disconnect reason code of http
Sometimes MQTT 3.x clients using `CleanSession=false` don't properly
unsubscribe. The URL parameter `defaultMqttSessionExpiryInterval` can be
configured on the MQTT `acceptor` so that abandoned sessions and subscription
queues will be cleaned up automatically after the expiry interval elapses.
+The default `defaultMqttSessionExpiryInterval` is `-1` which means no clean up
will happen for MQTT 3.x clients.
+Otherwise it represents the number of *seconds* which must elapse after the
client has disconnected before the broker will remove the session state and
subscription queues.
+
MQTT 5 has the same basic semantics with slightly different configuration.
The `CleanSession` flag was replaced with `CleanStart` and a
https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901048[session
expiry interval] property.
The broker will use the client's session expiry interval if it is set.
-If it is not set then the broker will apply the
`defaultMqttSessionExpiryInterval`.
+If it is not set or set to `0`, the session ends when the Network Connection
is closed.
-The default `defaultMqttSessionExpiryInterval` is `-1` which means no clean up
will happen for MQTT 3.x clients or for MQTT 5 clients which do not pass their
own session expiry interval.
-Otherwise it represents the number of *seconds* which must elapse after the
client has disconnected before the broker will remove the session state and
subscription queues.
MQTT session state is scanned every 5,000 milliseconds by default.
This can be changed using the `mqtt-session-scan-interval` element set in the
`core` section of `broker.xml`.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
For further information, visit: https://activemq.apache.org/contact
