From e7a27f0342634b65c7b19f032880ed116ba1c242 Mon Sep 17 00:00:00 2001 From: Justin Bertram Date: Tue, 12 Sep 2023 22:57:27 -0500 Subject: [PATCH] NO-JIRA a few small address-settings doc fixes --- docs/user-manual/address-settings.adoc | 37 +++++++++++++++++--------- 1 file changed, 24 insertions(+), 13 deletions(-) diff --git a/docs/user-manual/address-settings.adoc b/docs/user-manual/address-settings.adoc index bb7bba0938..ef922d3564 100644 --- a/docs/user-manual/address-settings.adoc +++ b/docs/user-manual/address-settings.adoc @@ -23,11 +23,11 @@ Here an example of an `address-setting` entry that might be found in the `broker DLA false - DLQ. + ExpiryQueue false - EXP. + 123 5000 @@ -35,19 +35,19 @@ Here an example of an `address-setting` entry that might be found in the `broker 0.0 10000 3 - 100000 - 1000 + -1 + -1 -1 - 20000 + 10MB PAGE - true + false false false false 0 -1 - 0 + -1 false -1 MESSAGES_PER_SECOND @@ -70,8 +70,9 @@ Here an example of an `address-setting` entry that might be found in the `broker 256 false -1 - - + MULTICAST + MULTICAST + 1048576 -1 0 true @@ -92,10 +93,12 @@ Read more in the chapter about xref:undelivered-messages.adoc#message-redelivery dead-letter-queue-prefix:: The prefix used for automatically created dead-letter queues. +Default is empty. Read more in the chapter about xref:undelivered-messages.adoc#message-redelivery-and-undelivered-messages[undelivered messages]. dead-letter-queue-suffix:: The suffix used for automatically created dead-letter queues. +Default is empty. Read more in the chapter about xref:undelivered-messages.adoc#message-redelivery-and-undelivered-messages[undelivered messages]. expiry-address:: @@ -109,10 +112,12 @@ Read more in the chapter about xref:undelivered-messages.adoc#message-redelivery expiry-queue-prefix:: The prefix used for automatically created expiry queues. +Default is empty. Read more in the chapter about xref:message-expiry.adoc#message-expiry[message expiry]. expiry-queue-suffix:: The suffix used for automatically created expiry queues. +Default is empty. Read more in the chapter about xref:message-expiry.adoc#message-expiry[message expiry]. expiry-delay:: @@ -141,9 +146,14 @@ defines an additional factor used to calculate an adjustment to the `redelivery- Default is `0.0`. Valid values are between 0.0 and 1.0. Read more about xref:undelivered-messages.adoc#configuring-delayed-redelivery[undelivered messages]. -+ -`max-size-bytes`, `max-size-messages`, `page-size-bytes`, `max-read-page-messages` & `max-read-page-bytes` are used to configure paging on an address. -This is explained xref:paging.adoc#configuration[here]. + +max-size-bytes:: +max-size-messages:: +page-size-bytes:: +max-read-page-messages:: +max-read-page-bytes:: +All these are used to configure paging on an address. +This is explained in the xref:paging.adoc#configuration[paging documentation]. max-size-bytes-reject-threshold:: is used with the address full `BLOCK` policy, the maximum size (in bytes) an address can reach before messages start getting rejected. @@ -187,6 +197,7 @@ Default is `-1` (wait forever). redistribution-delay:: How long to wait when the last consumer is closed on a queue before redistributing any messages. +Default is `-1`. Read more about xref:clusters.adoc#message-redistribution[clusters]. send-to-dla-on-no-route:: @@ -377,4 +388,4 @@ id-cache-size:: defines the maximum size of the duplicate ID cache for an address, as each address has it's own cache that helps to detect and prevent the processing of duplicate messages based on their unique identification. By default, the `id-cache-size` setting inherits from the global `id-cache-size`, with a default of `20000` -elements if not explicitly configured. Read more about xref:duplicate-detection.adoc#configuring-the-duplicate-id-cache[duplicate id cache sizes]. \ No newline at end of file +elements if not explicitly configured. Read more about xref:duplicate-detection.adoc#configuring-the-duplicate-id-cache[duplicate id cache sizes].