[jboss-cvs] JBoss Messaging SVN: r6763 - in trunk: examples/jms/last-value-queue and 1 other directory.

[jboss-cvs-commits at lists.jboss.org]

Author: jmesnil
Date: 2009-05-13 08:35:47 -0400 (Wed, 13 May 2009)
New Revision: 6763

Modified:
   trunk/docs/user-manual/en/modules/last-value-queues.xml
   trunk/examples/jms/last-value-queue/readme.html
Log:
user manual

* last value queues chapter


Modified: trunk/docs/user-manual/en/modules/last-value-queues.xml
===================================================================
--- trunk/docs/user-manual/en/modules/last-value-queues.xml	2009-05-13 10:46:33 UTC (rev 6762)
+++ trunk/docs/user-manual/en/modules/last-value-queues.xml	2009-05-13 12:35:47 UTC (rev 6763)
@@ -1,6 +1,50 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <chapter id="last-value-queues">
-    <title>Last Value Queues</title>
-    <para>blah</para>
-   
-</chapter>
+    <title>Last-Value Queues</title>
+       <para>Last-Value queues are special queues which discard any messages when
+        a newer message with the same value for a well-defined Last-Value property is put in the queue.
+        In other words, a Last-Value queue only retains the last value.</para>
+
+       <para>A typical example for Last-Value queue is for stock prices, where you are only 
+          interested by the latest value for a particular stock.</para>
+
+       <section>
+          <title>Configuring Last-Value Queues</title>
+          <para>Last-value queues are defined in the address-setting configuration:</para>
+          <programlisting>
+    &lt;address-setting match="jms.queue.lastValueQueue"&gt;
+       &lt;last-value-queue&gt;true&lt;/last-value-queue&gt;
+    &lt;/address-setting&gt;
+            </programlisting>
+          <para>By default, <literal>last-value-queue</literal> is false.</para>
+       </section>
+
+       <section>
+          <title>Using Last-Value Property</title>
+          <para>The property name used to identify the last value is <literal>_JBM_LVQ_NAME</literal>.</para>
+          <para>For example, if two messages with the same value for the Last-Value property are
+             sent to a Last-Value queue, only the latest message will be kept in the queue:</para>
+          <programlisting>
+             // send 1st message with Last-Value property set to STOCK_NAME
+             TextMessage message = session.createTextMessage("1st message with Last-Value property set");
+             message.setStringProperty("_JBM_LVQ_NAME", "STOCK_NAME");
+             producer.send(message);
+
+             // send 2nd message with Last-Value property set to STOCK_NAME             
+             message = session.createTextMessage("2nd message with Last-Value property set");
+             message.setStringProperty("_JBM_LVQ_NAME", "STOCK_NAME");
+             producer.send(message);
+             
+             ...
+             
+             // only the 2nd message will be received: it is the latest with the Last-Value property set
+             TextMessage messageReceived = (TextMessage)messageConsumer.receive(5000);
+             System.out.format("Received message: %s\n", messageReceived.getText());             
+            </programlisting>
+       </section>
+          
+       <section>
+          <title>Example</title>
+          <para>The <ulink url="../../../../examples/jms/last-value-queue/readme.html">Last-Value Queue example</ulink> shows
+             how last value queues are configured and used with JMS.</para>
+       </section></chapter>

Modified: trunk/examples/jms/last-value-queue/readme.html
===================================================================
--- trunk/examples/jms/last-value-queue/readme.html	2009-05-13 10:46:33 UTC (rev 6762)
+++ trunk/examples/jms/last-value-queue/readme.html	2009-05-13 12:35:47 UTC (rev 6763)
@@ -18,7 +18,7 @@
      <h2>Example setup</h2>
      <p>Last-Value queues are defined in the queue settings configuration file <a href="server0/jbm-queues.xml">jbm-queues.xml</a>:</p>
      <pre>
-         <code>&lt;address-settings match="jms.queue.lastValue"&gt;
+         <code>&lt;address-settings match="jms.queue.lastValueQueue"&gt;
                 &lt;last-value-queue&gt;true&lt;/last-value-queue&gt;
          &lt;/address-settings&gt;</code>
      </pre>          
@@ -134,7 +134,7 @@
      <h2>More information</h2>
      
      <ul>
-         <li>Last-Value queue is <a href="../../../docs/userguide/en/html/configuration.html#configuration.queues">configured on a queue-basis</a></li>
+        <li>User Manual's <a href="../../../docs/user-manual/en/html_single/index.html#last-value-queues">Last-Value Queues chapter</a></li>
      </ul>
   </body>
 </html>
\ No newline at end of file