[jboss-cvs] JBoss Messaging SVN: r4348 - trunk/docs/userguide/en/modules.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu May 29 13:54:01 EDT 2008
Author: ataylor
Date: 2008-05-29 13:54:01 -0400 (Thu, 29 May 2008)
New Revision: 4348
Modified:
trunk/docs/userguide/en/modules/runningexamples.xml
Log:
added config to docs
Modified: trunk/docs/userguide/en/modules/runningexamples.xml
===================================================================
--- trunk/docs/userguide/en/modules/runningexamples.xml 2008-05-29 16:47:02 UTC (rev 4347)
+++ trunk/docs/userguide/en/modules/runningexamples.xml 2008-05-29 17:54:01 UTC (rev 4348)
@@ -2,10 +2,11 @@
<chapter id="examples">
<title>Running the Examples</title>
- <para>In the directory <literal>examples</literal>, you will find 2 sets of examples:</para>
+ <para>In the directory<literal>examples</literal>, you will find 2 sets of examples:
+ </para>
<itemizedlist>
- <listitem>a set of JMS examples</listitem>
- <listitem>a set of non-JMS examples that demonstrate how to use the JBoss Messaging core API</listitem>
+ <listitem>a set of JMS examples</listitem>
+ <listitem>a set of non-JMS examples that demonstrate how to use the JBoss Messaging core API</listitem>
</itemizedlist>
<para>It is highly recommended that you familiarize yourself with the
examples.
@@ -76,11 +77,19 @@
<listitem>
<para>perfSender</para>
<para>This example will run a basic performance test. before running start the example and wait for it to
- start, you will see <literal>READY!!!</literal> when the listener has started. The number of messages,
- delivery mode can be configured as follows:
+ start, you will see
+ <literal>READY!!!</literal>
+ when the listener has started. The number of messages,
+ delivery mode etc can be configured as follows:
<programlisting>
- ant -Dmessage.count=20000 -Ddelivery.mode=PERSISTENT perfSender
+ ant -Dmessage.count=20000 -Ddelivery.mode=PERSISTENT perfSender
</programlisting>
+ </para>
+ <para>If running the sender and listener seperately make sure to run the listener with the parameter
+ <literal>drain.queue</literal>
+ set to false
+ </para>
+ <para>
<itemizedlist>
<listitem>
<para>message.count</para>
@@ -91,19 +100,61 @@
<para>The delivery mode to use, PERSISTENT or NON_PERSISTENT.</para>
</listitem>
<listitem>
- <para>message.count</para>
- <para>The sample period, in seconds</para>
+ <para>message.warmup.count</para>
+ <para>How many messages to warm up for. Because of the JIT compiler maximum throughput will take a
+ little
+ while to kick in.
+ </para>
</listitem>
+ <listitem>
+ <para>message.size</para>
+ <para>The size of message to send.</para>
+ </listitem>
+ <listitem>
+ <para>sess.trans</para>
+ <para>Whether or not the session is transacted.</para>
+ </listitem>
+ <listitem>
+ <para>sess.trans.size</para>
+ <para>If the session is transacted the batch size to commit.</para>
+ </listitem>
+ <listitem>
+ <para>sess.ackmode</para>
+ <para>The acknowledge mode to use, DUPS_OK or AUTO_ACK. Ignored if the session is transacted</para>
+ </listitem>
+ <listitem>
+ <para>drain.queue</para>
+ <para>Whether or not the listener will empty the queue before starting.</para>
+ </listitem>
+ <listitem>
+ <para>queue.lookup</para>
+ <para>The name of the queue to use.</para>
+ </listitem>
+ <listitem>
+ <para>cf.lookup</para>
+ <para>The name of the connection factory to use.</para>
+ </listitem>
</itemizedlist>
</para>
+ <para>There are also some ant targets for running the perf sender and listener in different modes:
+ <programlisting>
+ perfNonTransactionalSender
+ perfTransactionalSender
+ perfAutoAckListener
+ perfDupsOKListener
+ perfDupsOKListener
+ </programlisting>
+ </para>
</listitem>
</itemizedlist>
</section>
<section id="examples.messaging">
<title>The Messaging examples</title>
- <para>The messaging examples demonstrate the use of the messaging core API and also how to create and run an embedded
- instance of JBM. The following examples are available:</para>
+ <para>The messaging examples demonstrate the use of the messaging core API and also how to create and run an
+ embedded
+ instance of JBM. The following examples are available:
+ </para>
<para>to run a specific example open up a shell or command prompt and navigate into the
<literal>examples/messaging</literal>
directory and run the command ant followed by the example name, as follows
@@ -121,7 +172,8 @@
<listitem>
<para>SSLClient</para>
<para>This example shows a simple send and receive to a remote queue using SS. The server will need to be
- running and configyred to use SSL for this example. Refer to the configuration chapter for details on how to do this
+ running and configyred to use SSL for this example. Refer to the configuration chapter for details on how
+ to do this
</para>
</listitem>
<listitem>
More information about the jboss-cvs-commits
mailing list