[jboss-cvs] JBoss Messaging SVN: r6765 - in trunk: examples/jms/scheduled-message and 1 other directories.

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

Author: jmesnil
Date: 2009-05-13 09:45:26 -0400 (Wed, 13 May 2009)
New Revision: 6765

Modified:
   trunk/docs/user-manual/en/modules/scheduled-messages.xml
   trunk/examples/jms/scheduled-message/readme.html
   trunk/examples/jms/scheduled-message/src/org/jboss/jms/example/ScheduledMessageExample.java
Log:
user manual

* scheduled messages chapter
* updated scheduled-messages example readme

Modified: trunk/docs/user-manual/en/modules/scheduled-messages.xml
===================================================================
--- trunk/docs/user-manual/en/modules/scheduled-messages.xml	2009-05-13 13:37:25 UTC (rev 6764)
+++ trunk/docs/user-manual/en/modules/scheduled-messages.xml	2009-05-13 13:45:26 UTC (rev 6765)
@@ -1,6 +1,31 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <chapter id="scheduled-messages">
-    <title>Scheduled Messages</title>
-    <para>blah</para>
-    
+   <title>Scheduled Messages</title>
+   <para>Scheduled messages are delivered at a time specified by the sender rather than when request by the receiver.</para>
+   <para>Messages are scheduled for later delivery if they have a well-known scheduled delivery property set.</para>
+   
+   <section>
+      <title>Scheduled Delivery Property</title>
+      <para>The property name used to identify a scheduled message is <literal>"_JBM_SCHED_DELIVERY"</literal> (or
+      the constant <literal>MessageImpl.HDR_SCHEDULED_DELIVERY_TIME</literal>).</para>
+      <para>The specified value must be a <literal>long</literal> corresponding to the time the message
+      must be delivered (in milliseconds).</para>
+      <programlisting>
+         TextMessage message = session.createTextMessage("This is a scheduled message message which will be delivered in 5 sec.");
+         message.setLongProperty("_JBM_SCHED_DELIVERY", System.currentTimeMillis() + 5000);
+         producer.send(message);
+
+         ...
+         
+         // message will not be received immediately but 5 seconds later
+         TextMessage messageReceived = (TextMessage) consumer.receive();
+        </programlisting>
+   </section>
+         
+   <section>
+      <title>Example</title>
+      <para>The <ulink url="../../../../examples/jms/scheduled-message/readme.html">Scheduled Message example</ulink> shows
+      how scheduled messages can be used with JMS.</para>
+   </section>
+   
 </chapter>

Modified: trunk/examples/jms/scheduled-message/readme.html
===================================================================
--- trunk/examples/jms/scheduled-message/readme.html	2009-05-13 13:37:25 UTC (rev 6764)
+++ trunk/examples/jms/scheduled-message/readme.html	2009-05-13 13:45:26 UTC (rev 6765)
@@ -50,7 +50,7 @@
 
         <li>We create a JMS text message that we are going to send.</li>
         <pre>
-           <code>TextMessage message = session.createTextMessage("This is a scheduled message message will arrived in 5 sec.");</code>
+           <code>TextMessage message = session.createTextMessage("This is a scheduled message message which will be delivered in 5 sec.");</code>
         </pre>
 
         <li>We schedule the delivery time to be 5 sec later.</li>
@@ -99,5 +99,12 @@
         </pre>
 
      </ol>
+     
+     <h2>More information</h2>
+     
+     <ul>
+         <li>User Manual's <a href="../../../docs/user-manual/en/html_single/index.html#scheduled-messages">Scheduled Messages chapter</a></li>
+     </ul>
+     
   </body>
 </html>
\ No newline at end of file

Modified: trunk/examples/jms/scheduled-message/src/org/jboss/jms/example/ScheduledMessageExample.java
===================================================================
--- trunk/examples/jms/scheduled-message/src/org/jboss/jms/example/ScheduledMessageExample.java	2009-05-13 13:37:25 UTC (rev 6764)
+++ trunk/examples/jms/scheduled-message/src/org/jboss/jms/example/ScheduledMessageExample.java	2009-05-13 13:45:26 UTC (rev 6765)
@@ -72,7 +72,7 @@
          MessageProducer producer = session.createProducer(queue);
 
          //Step 7. Create a Text Message
-         TextMessage message = session.createTextMessage("This is a scheduled message message will arrived in 5 sec.");
+         TextMessage message = session.createTextMessage("This is a scheduled message message which will be delivered in 5 sec.");
 
          //Step 8. Set the delivery time to be 5 sec later.
          long time = System.currentTimeMillis();