[activemq-artemis] branch main updated: NO-JIRA clarify MQTT sub queue clean-up doc

[jb...@apache.org]

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 c2a9ec73a3 NO-JIRA clarify MQTT sub queue clean-up doc
c2a9ec73a3 is described below

commit c2a9ec73a33c7951050ddaeb4a0a713a602bb616
Author: Justin Bertram <jb...@apache.org>
AuthorDate: Fri Mar 3 14:26:22 2023 -0600

    NO-JIRA clarify MQTT sub queue clean-up doc
---
 docs/user-manual/en/mqtt.md | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/docs/user-manual/en/mqtt.md b/docs/user-manual/en/mqtt.md
index 59cf05b85f..383c26bda5 100644
--- a/docs/user-manual/en/mqtt.md
+++ b/docs/user-manual/en/mqtt.md
@@ -186,11 +186,18 @@ Web browsers can then connect to `wss://<server>:8883` using a Web Socket to
 send and receive MQTT messages.
 
 
-## Automatic Subscription Clean-up
+## Automatic Subscription Clean-up 
 
-Sometimes MQTT clients don't clean up their subscriptions. In such situations
-the `auto-delete-queues-delay` and `auto-delete-queues-message-count`
-address-settings can be used to clean up the abandoned subscription queues.
+Sometimes MQTT clients using `CleanSession=false` don't clean up their
+subscriptions. In such situations the following address-setting can be used
+to clean up the abandoned subscription queues:
+```xml
+   <address-setting match="myMqttAddress">
+      <auto-delete-created-queues>true</auto-delete-created-queues>
+      <auto-delete-queues-delay>3600000</auto-delete-queues-delay> <!-- 1 hour delay -->
+      <auto-delete-queues-message-count>-1</auto-delete-queues-message-count> <!-- doesn't matter how many messages there are -->
+   </address-setting>
+```
 However, the MQTT session meta-data is still present in memory and needs to be
 cleaned up as well. The URL parameter `defaultMqttSessionExpiryInterval` can be
 configured on the MQTT `acceptor` to deal with this situation.