Author: rgodfrey
Date: Tue May 17 10:44:25 2016
New Revision: 1744250
URL: http://svn.apache.org/viewvc?rev=1744250&view=rev
Log:
QPID-7255 : Add documentation for delivery delay feature
Modified:
qpid/java/trunk/broker-core/src/main/java/org/apache/qpid/server/model/Queue.java
qpid/java/trunk/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml
qpid/java/trunk/doc/jms-client-0-10/src/docbkx/JMS-Client-0-10-Book.xml
qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Binding-URL.xml
Modified:
qpid/java/trunk/broker-core/src/main/java/org/apache/qpid/server/model/Queue.java
URL:
http://svn.apache.org/viewvc/qpid/java/trunk/broker-core/src/main/java/org/apache/qpid/server/model/Queue.java?rev=1744250&r1=1744249&r2=1744250&view=diff
==============================================================================
---
qpid/java/trunk/broker-core/src/main/java/org/apache/qpid/server/model/Queue.java
(original)
+++
qpid/java/trunk/broker-core/src/main/java/org/apache/qpid/server/model/Queue.java
Tue May 17 10:44:25 2016
@@ -198,7 +198,12 @@ public interface Queue<X extends Queue<X
@ManagedContextDefault( name = "queue.holdOnPublishEnabled")
boolean DEFAULT_HOLD_ON_PUBLISH_ENABLED = false;
- @ManagedAttribute( defaultValue = "${queue.holdOnPublishEnabled}")
+ @ManagedAttribute( defaultValue = "${queue.holdOnPublishEnabled}",
+ description = "If true then entries in the queue will
be held (not made available for delivery or "
+ + "browsing) until the time (specified in
milliseconds since the epoch) given in "
+ + "the message header (AMQP
0-8,0-9,0-9-1,0-10) or message annotation (AMQP 1.0) "
+ + "\"x-qpid-not-valid-before\". Note
that the actual time the entry is made "
+ + "visible may depend on how frequently
the virtual host housekeeping thread runs.")
boolean isHoldOnPublishEnabled();
//children
Modified:
qpid/java/trunk/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml
URL:
http://svn.apache.org/viewvc/qpid/java/trunk/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml?rev=1744250&r1=1744249&r2=1744250&view=diff
==============================================================================
---
qpid/java/trunk/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml
(original)
+++
qpid/java/trunk/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml
Tue May 17 10:44:25 2016
@@ -358,4 +358,21 @@ amqp://guest:guest@client1/development?m
</screen>
</section>
</section>
-</section>
+ <section xml:id="Java-Broker-Concepts-Queue-HoldingEntries">
+ <title>Holding messages on a Queue</title>
+ <para>Sometimes it is required that while a message has been placed on
a queue, it is not released to consumers
+ until some external condition is met. </para>
+ <section>
+ <title>Hold until valid</title>
+ <para>Currently Queues support the "holding" of messages until a
(per-message) provided point in time.
+ By default this support is not enabled (since it requires
extra work to be performed against every
+ message entering the queue. To enable support, the attribute
<varname>holdOnPublishEnabled</varname>
+ must evaluate to true for the Queue. When enabled messages on
the queue will be checked for the header
+ (for AMQP 0-8, 0-9, 0-9-1 and 0-10 messages) or message
annotation (for AMQP 1.0 messages)
+ <varname>x-qpid-not-valid-before</varname>. If this
header/annotation exists and contains a numeric value,
+ it will be treated as a point in time given in milliseconds
since the UNIX epoch. The message will not
+ be released from the Queue to consumers until this time has
been reached.
+ </para>
+ </section>
+ </section>
+ </section>
Modified:
qpid/java/trunk/doc/jms-client-0-10/src/docbkx/JMS-Client-0-10-Book.xml
URL:
http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-10/src/docbkx/JMS-Client-0-10-Book.xml?rev=1744250&r1=1744249&r2=1744250&view=diff
==============================================================================
--- qpid/java/trunk/doc/jms-client-0-10/src/docbkx/JMS-Client-0-10-Book.xml
(original)
+++ qpid/java/trunk/doc/jms-client-0-10/src/docbkx/JMS-Client-0-10-Book.xml Tue
May 17 10:44:25 2016
@@ -2068,7 +2068,21 @@ spout - -content "$(cat rdu.xml | sed -e
node creation.
</entry>
</row>
- </tbody>
+ <row>
+ <entry>
+ delay
+ </entry>
+ <entry>
+ long
+ </entry>
+ <entry>
+ The delay (in milliseconds) between the time a message is sent
by a MessageProducer, and
+ the earliest time it becomes visible to consumers on
any queue onto which it has been placed. Note that
+ this value only has an affect on brokers which
support the feature (currently only the Qpid Java
+ Broker), and only on queues where delivery delay has
been enabled.
+ </entry>
+ </row>
+ </tbody>
</tgroup>
</table>
Modified:
qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Binding-URL.xml
URL:
http://svn.apache.org/viewvc/qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Binding-URL.xml?rev=1744250&r1=1744249&r2=1744250&view=diff
==============================================================================
--- qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Binding-URL.xml
(original)
+++ qpid/java/trunk/doc/jms-client-0-8/src/docbkx/JMS-Client-Binding-URL.xml
Tue May 17 10:44:25 2016
@@ -150,6 +150,15 @@
<entry><para>A semi-colon separated list of the names of the
recipients who will be able to decrypt the
message. </para></entry>
</row>
+
+ <row xml:id="JMS-Client-0-8-Binding-URL-Options-DeliveryDelay">
+ <entry><para>deliveryDelay</para></entry>
+ <entry><para>long </para></entry>
+ <entry><para>The delay (in milliseconds) between the time a
message is sent by a MessageProducer, and
+ the earliest time it becomes visible to consumers on any
queue onto which it has been placed. Note that
+ this value only has an affect on brokers which support the
feature (currently only the Qpid Java
+ Broker), and only on queues where delivery delay has been
enabled.</para></entry>
+ </row>
</tbody>
</tgroup>
</table>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org
For additional commands, e-mail: commits-h...@qpid.apache.org
