ARTEMIS-1991 document advanced destination options

artemis-server/src/main/resources/schema/artemis-configuration.xsd

@@ -2829,7 +2829,8 @@
             <xsd:element name="default-delay-before-dispatch" type="xsd:long" default="-1" maxOccurs="1" minOccurs="0">
                <xsd:annotation>
                   <xsd:documentation>
-                     the default delay to wait before dispatching if number of consumers before dispatch is not met for queues under the address.
+                     the default delay (in milliseconds) to wait before dispatching if number of consumers before
+                     dispatch is not met for queues under the address.
                   </xsd:documentation>
                </xsd:annotation>
             </xsd:element>

docs/user-manual/en/address-model.md

@@ -583,7 +583,9 @@ that would be found in the `broker.xml` file.
       <message-counter-history-day-limit></message-counter-history-day-limit>
       <last-value-queue>true</last-value-queue> <!-- deprecated! see default-last-value-queue -->
       <default-last-value-queue>true</default-last-value-queue>
-      <default-exclusive-queue></default-exclusive-queue>
+      <default-exclusive-queue>false</default-exclusive-queue>
+      <default-consumers-before-dispatch>0</default-consumers-before-dispatch>
+      <default-delay-before-dispatch>-1</default-delay-before-dispatch>
       <redistribution-delay>0</redistribution-delay>
       <send-to-dla-on-no-route>true</send-to-dla-on-no-route>
       <slow-consumer-threshold>-1</slow-consumer-threshold>
@@ -690,6 +692,17 @@ consumer. Default is `false`. This value can be overridden at the queue level
 using the `exclusive` boolean. Read more about [exclusive
 queues](exclusive-queues.md).
 
+`default-consumers-before-dispatch` defines the number of consumers needed on a
+queue bound to the matching address before messages will be dispatched to those
+consumers. Default is `0`. This value can be overridden at the queue level using
+the `consumers-before-dispatch` boolean. This behavior can be tuned using
+`delay-before-dispatch` on the queue itself or by using the
+`default-delay-before-dispatch` address-setting.
+
+`default-delay-before-dispatch` defines the number of milliseconds the broker
+will wait for the configured number of consumers to connect to the matching queue
+before it will begin to dispatch messages. Default is `-1` (wait forever).
+
 `redistribution-delay` defines how long to wait when the last consumer is
 closed on a queue before redistributing any messages. Read more about
 [clusters](clusters.md#message-redistribution).

docs/user-manual/en/configuration-index.md

@@ -204,6 +204,8 @@ Name | Description | Default
 [last-value-queue](last-value-queues.md) | **deprecated** Queue is a last value queue; see `default-last-value-queue` instead | `false`
 [default-last-value-queue](last-value-queues.md)| `last-value` value if none is set on the queue | `false`
 [default-exclusive-queue](exclusive-queues.md) | `exclusive` value if none is set on the queue | `false`
+[default-consumers-before-dispatch](exclusive-queues.md) | `consumers-before-dispatch` value if none is set on the queue | 0
+[default-delay-before-dispatch](exclusive-queues.md) | `delay-before-dispatch` value if none is set on the queue | -1
 [redistribution-delay](clusters.md) | Timeout before redistributing values after no consumers | -1
 [send-to-dla-on-no-route](address-model.md) | Forward messages to DLA when no queues subscribing | `false`
 [slow-consumer-threshold](slow-consumers.md) | Min rate of msgs/sec consumed before a consumer is considered "slow" | -1
@@ -338,6 +340,8 @@ user | the name of the user to associate with the creation of the queue | n/a
 [purge-on-no-consumers](address-model.md#non-durable-subscription-queue) | whether or not to delete all messages and prevent routing when no consumers are connected | `false`
 [exclusive](exclusive-queues.md) | only deliver messages to one of the connected consumers | `false`
 [last-value](last-value-queues.md) | use last-value semantics | `false`
+consumers-before-dispatch | number of consumers required before dispatching messages | 0
+delay-before-dispatch | milliseconds to wait for `consumers-before-dispatch` to be met before dispatching messages anyway | -1 (wait forever)
 
 
 ## security-setting type