[hornetq-commits] JBoss hornetq SVN: r10415 - trunk/hornetq-rest/docbook/reference/en.

do-not-reply at jboss.org do-not-reply at jboss.org
Tue Mar 29 22:48:02 EDT 2011 

Author: bill.burke at jboss.com
Date: 2011-03-29 22:48:02 -0400 (Tue, 29 Mar 2011)
New Revision: 10415

Modified:
   trunk/hornetq-rest/docbook/reference/en/master.xml
Log:
blah


Modified: trunk/hornetq-rest/docbook/reference/en/master.xml
===================================================================
--- trunk/hornetq-rest/docbook/reference/en/master.xml	2011-03-30 00:38:59 UTC (rev 10414)
+++ trunk/hornetq-rest/docbook/reference/en/master.xml	2011-03-30 02:48:02 UTC (rev 10415)
@@ -5,7 +5,7 @@
   <bookinfo>
     <title>HornetQ REST Interface</title>
 
-    <releaseinfo>2.2.0</releaseinfo>
+    <releaseinfo>2.2.2</releaseinfo>
   </bookinfo>
 
   <toc></toc>
@@ -307,6 +307,7 @@
    &lt;dups-ok&gt;true&lt;/dups-ok&gt;
    &lt;topic-push-store-dir&gt;topic-push-store&lt;/topic-push-store-dir&gt;
    &lt;queue-push-store-dir&gt;queue-push-store&lt;/queue-push-store-dir&gt;
+   &lt;producer-time-to-live&gt;0&lt;/producer-time-to-live&gt;
    &lt;producer-session-pool-size&gt;10&lt;/producer-session-pool-size&gt;
    &lt;session-timeout-task-interval&gt;1&lt;/session-timeout-task-interval&gt;
    &lt;consumer-session-timeout-seconds&gt;300&lt;/consumer-session-timeout-seconds&gt;
@@ -388,6 +389,15 @@
         </varlistentry>
 
         <varlistentry>
+          <term>producer-time-to-live</term>
+
+          <listitem>
+            <para>Default time to live for posted messages. Default is no
+            ttl.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
           <term>session-timeout-task-interval</term>
 
           <listitem>
@@ -809,9 +819,19 @@
 &lt;/order&gt;
 </programlisting>
     </sect1>
-   <sect1>
-     <title>Expiration and Priority</title>
-     <para>You can set he expiration and the priority of the message in the queue or topic by setting an additional query parameter.  The <literal>expiration</literal> query parameter is an integer expressing the time in milliseconds until the message should be expired.  The <literal>priority</literal> is another query parameter with an integer value between 0 and 9 expressing the priority of the message. i.e.:</para>
+
+    <sect1>
+      <title>TTL, Expiration and Priority</title>
+
+      <para>You can set the time to live, expiration, and/or the priority of
+      the message in the queue or topic by setting an additional query
+      parameter. The <literal>expiration</literal> query parameter is an long
+      specify the time in milliseconds since epoch (a long date). The
+      <literal>ttl</literal> query parameter is a time in milliseconds you
+      want the message active. The <literal>priority</literal> is another
+      query parameter with an integer value between 0 and 9 expressing the
+      priority of the message. i.e.:</para>
+
       <programlisting>POST /queues/jms.queue.bar/create?expiration=30000&amp;priority=3
 Host: example.com
 Content-Type: application/xml
@@ -822,7 +842,7 @@
    &lt;cost&gt;$199.99&lt;/cost&gt;
 &lt;/order&gt;
 </programlisting>
-   </sect1>
+    </sect1>
   </chapter>
 
   <chapter>
@@ -884,6 +904,7 @@
           the server. Only usable on topics.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>selector</term>
 
@@ -894,6 +915,24 @@
           charactor is converted to a '$'.</para>
         </listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term>idle-timeout</term>
+
+        <listitem>
+          <para>For a topic subscription, idle time in milliseconds in which
+          the consumer connections will be closed if idle.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>delete-when-idle</term>
+
+        <listitem>
+          <para>Boolean value, If true, a topic subscription will be deleted
+          (even if it is durable) when an the idle timeout is reached.</para>
+        </listitem>
+      </varlistentry>
     </variablelist>
 
     <sect1>
@@ -1509,6 +1548,9 @@
        ]]&gt;
    &lt;/selector&gt;
    &lt;link rel="push" href="http://somewhere.com" type="application/json" method="PUT"/&gt;
+   &lt;maxRetries&gt;5&lt;/maxRetries&gt;
+   &lt;retryWaitMillis&gt;1000&lt;/retryWaitMillis&gt;
+   &lt;disableOnFailure&gt;true&lt;/disableOnFailure&gt;
 &lt;/push-registration&gt;
 </programlisting>
 
@@ -1525,6 +1567,19 @@
       JMS message selector. You should enclose it within CDATA blocks as some
       of the selector characters are illegal XML.</para>
 
+      <para>The <literal>maxRetries</literal> element specifies how many times
+      a the server will try to push a message to a URL if there is a
+      connection failure.</para>
+
+      <para>The <literal>retryWaitMillis</literal> element specifies how long
+      to wait before performing a retry.</para>
+
+      <para>The <literal>disableOnFailure</literal> element, if set to true,
+      will disable the registration if all retries have failed. It will not
+      disable the connection on non-connection-failure issues (like a bad
+      request for instance). In these cases, the dead letter queue logic of
+      HornetQ will take over.</para>
+
       <para>The <literal>link</literal> element specifies the basis of the
       interaction. The <literal>href</literal> attribute contains the URL you
       want to interact with. It is the only required attribute. The
@@ -1595,7 +1650,7 @@
 
       <para>The push XML for a topic is the same except the root element is
       push-topic-registration. (Also remember the <literal>selector</literal>
-      element is optional).  The rest of the document is the same. Here's an
+      element is optional). The rest of the document is the same. Here's an
       example of a template registration:</para>
 
       <programlisting>&lt;push-topic-registration&gt;

More information about the hornetq-commits mailing list