[jboss-cvs] JBoss Messaging SVN: r6888 - trunk/docs/user-manual/en/modules.

jboss-cvs-commits at lists.jboss.org jboss-cvs-commits at lists.jboss.org
Tue May 19 10:31:16 EDT 2009


Author: ataylor
Date: 2009-05-19 10:31:16 -0400 (Tue, 19 May 2009)
New Revision: 6888

Modified:
   trunk/docs/user-manual/en/modules/clusters.xml
   trunk/docs/user-manual/en/modules/configuration-index.xml
   trunk/docs/user-manual/en/modules/connection-ttl.xml
   trunk/docs/user-manual/en/modules/flow-control.xml
   trunk/docs/user-manual/en/modules/large-messages.xml
   trunk/docs/user-manual/en/modules/send-guarantees.xml
Log:
added reference and links

Modified: trunk/docs/user-manual/en/modules/clusters.xml
===================================================================
--- trunk/docs/user-manual/en/modules/clusters.xml	2009-05-19 14:20:15 UTC (rev 6887)
+++ trunk/docs/user-manual/en/modules/clusters.xml	2009-05-19 14:31:16 UTC (rev 6888)
@@ -185,7 +185,7 @@
                 </listitem>
             </itemizedlist>
         </section>
-        <section>
+        <section id="clusters-discovery.groups.clientside">
             <title>Discovery Groups on the Client Side</title>
             <para>Let's discuss how to configure a JBoss Messaging client to use discovery to
                 discover a list of servers to which it can connect. The way to do this differs
@@ -393,7 +393,7 @@
             </itemizedlist>
         </section>
     </section>
-    <section>
+    <section id="clusters.client.loadbalancing">
         <title>Client-Side Load balancing</title>
         <para>With JBoss Messaging client-side connection load balancing, subsequent client
             connections created using a single factory can be made to different nodes of the

Modified: trunk/docs/user-manual/en/modules/configuration-index.xml
===================================================================
--- trunk/docs/user-manual/en/modules/configuration-index.xml	2009-05-19 14:20:15 UTC (rev 6887)
+++ trunk/docs/user-manual/en/modules/configuration-index.xml	2009-05-19 14:31:16 UTC (rev 6888)
@@ -469,141 +469,163 @@
                     </thead>
                     <tbody>
                         <row>
-                            <entry>discoveryRefreshTimeout</entry>
+                            <entry><link linkend="clusters-discovery.groups.clientside"
+                                    >discoveryRefreshTimeout</link></entry>
+                            <entry>long</entry>
                             <entry/>
-                            <entry/>
                             <entry>10000</entry>
                         </row>
                         <row>
-                            <entry>pingPeriod</entry>
+                            <entry><link linkend="dead.connections">pingPeriod</link></entry>
+                            <entry>long</entry>
                             <entry/>
-                            <entry/>
                             <entry>1000000</entry>
                         </row>
                         <row>
-                            <entry>connectionTTL</entry>
+                            <entry><link linkend="dead.connections">connectionTTL</link></entry>
+                            <entry>long</entry>
                             <entry/>
-                            <entry/>
                             <entry>5 * 60000</entry>
                         </row>
                         <row>
                             <entry>callTimeout</entry>
+                            <entry>long</entry>
                             <entry/>
-                            <entry/>
                             <entry>30000</entry>
                         </row>
                         <row>
-                            <entry>maxConnections</entry>
+                            <entry><link linkend="connection-ttl.session.multiplexing"
+                                    >maxConnections</link></entry>
+                            <entry>int</entry>
                             <entry/>
-                            <entry/>
                             <entry>8</entry>
                         </row>
                         <row>
-                            <entry>minLargeMessageSize</entry>
+                            <entry><link linkend="large-messages.core.config"
+                                    >minLargeMessageSize</link></entry>
+                            <entry>int</entry>
                             <entry/>
-                            <entry/>
                             <entry>100 * 1024</entry>
                         </row>
                         <row>
-                            <entry>consumerWindowSize</entry>
+                            <entry><link linkend="flow-control.core.api"
+                                >consumerWindowSize</link></entry>
+                            <entry>int</entry>
                             <entry/>
-                            <entry/>
                             <entry>1024 * 1024</entry>
                         </row>
                         <row>
-                            <entry>consumerMaxRate</entry>
+                            <entry><link linkend="flow-control.rate.core.api"
+                                >consumerMaxRate</link></entry>
+                            <entry>int</entry>
                             <entry/>
-                            <entry/>
                             <entry>-1</entry>
                         </row>
                         <row>
                             <entry>producerWindowSize</entry>
+                            <entry>int</entry>
                             <entry/>
-                            <entry/>
                             <entry>1024 * 1024</entry>
                         </row>
                         <row>
-                            <entry>producerMaxRate</entry>
+                            <entry><link linkend="flow-control.producer.rate.core.api"
+                                    >producerMaxRate</link></entry>
+                            <entry>int</entry>
                             <entry/>
-                            <entry/>
                             <entry>-1</entry>
                         </row>
                         <row>
-                            <entry>blockOnAcknowledge</entry>
+                            <entry><link linkend="send-guarantees.nontrans.acks"
+                                    >blockOnAcknowledge</link></entry>
+                            <entry>boolean</entry>
                             <entry/>
-                            <entry/>
                             <entry>false</entry>
                         </row>
                         <row>
-                            <entry>blockOnPersistentSend</entry>
+                            <entry><link linkend="non-transactional-sends"
+                                    >blockOnPersistentSend</link></entry>
+                            <entry>boolean</entry>
                             <entry/>
-                            <entry/>
                             <entry>false</entry>
                         </row>
                         <row>
-                            <entry>blockOnNonPersistentSend</entry>
+                            <entry><link linkend="non-transactional-sends"
+                                    >blockOnNonPersistentSend</link></entry>
+                            <entry>boolean</entry>
                             <entry/>
-                            <entry/>
                             <entry>false</entry>
                         </row>
                         <row>
                             <entry>autoGroup</entry>
+                            <entry>boolean</entry>
                             <entry/>
+                            <entry>false</entry>
+                        </row>
+                        <row>
+                            <entry>preAcknowledge</entry>
+                            <entry>boolean</entry>
                             <entry/>
                             <entry>false</entry>
                         </row>
                         <row>
                             <entry>ackBatchSize</entry>
+                            <entry>int</entry>
                             <entry/>
-                            <entry/>
                             <entry>1024 * 1024</entry>
                         </row>
                         <row>
-                            <entry>loadBalancingPolicyClassName</entry>
+                            <entry><link linkend="clusters.client.loadbalancing"
+                                    >loadBalancingPolicyClassName</link></entry>
+                            <entry>String</entry>
                             <entry/>
-                            <entry/>
                             <entry>org.jboss.messaging.core.client.impl.RoundRobinConnectionLoadBalancingPolicy</entry>
                         </row>
                         <row>
                             <entry>initialWaitTimeout</entry>
+                            <entry>long</entry>
                             <entry/>
-                            <entry/>
                             <entry>2000</entry>
                         </row>
                         <row>
                             <entry>useGlobalPools</entry>
+                            <entry>boolean</entry>
                             <entry/>
-                            <entry/>
                             <entry>true</entry>
                         </row>
                         <row>
+                            <entry>scheduledThreadPoolMaxSize</entry>
+                            <entry>int</entry>
+                            <entry/>
+                            <entry>2</entry>
+                        </row>
+                        <row>
                             <entry>threadPoolMaxSize</entry>
+                            <entry>int</entry>
                             <entry/>
-                            <entry/>
                             <entry>-1</entry>
                         </row>
                         <row>
                             <entry>retryInterval</entry>
+                            <entry>long</entry>
                             <entry/>
-                            <entry/>
-                            <entry/>
+                            <entry>2000</entry>
                         </row>
                         <row>
                             <entry>retryIntervalMultiplier</entry>
+                            <entry>double</entry>
                             <entry/>
-                            <entry/>
                             <entry>1d</entry>
                         </row>
                         <row>
                             <entry>reconnectAttempts</entry>
+                            <entry>int</entry>
                             <entry/>
-                            <entry/>
                             <entry>0</entry>
                         </row>
                         <row>
                             <entry>failoverOnServerShutdown</entry>
+                            <entry>boolean</entry>
                             <entry/>
-                            <entry/>
                             <entry>false</entry>
                         </row>
                     </tbody>

Modified: trunk/docs/user-manual/en/modules/connection-ttl.xml
===================================================================
--- trunk/docs/user-manual/en/modules/connection-ttl.xml	2009-05-19 14:20:15 UTC (rev 6887)
+++ trunk/docs/user-manual/en/modules/connection-ttl.xml	2009-05-19 14:31:16 UTC (rev 6888)
@@ -117,7 +117,7 @@
             are using JMS) depending on how it has been configured.</para>
         <para/>
     </section>
-    <section>
+    <section id="connection-ttl.session.multiplexing">
         <title>Session Multiplexing</title>
         <para>Each <literal>ClientSessionFactory</literal> creates connections on demand to the same
             server as you create sessions. Each instance will create up to a maximum of <literal

Modified: trunk/docs/user-manual/en/modules/flow-control.xml
===================================================================
--- trunk/docs/user-manual/en/modules/flow-control.xml	2009-05-19 14:20:15 UTC (rev 6887)
+++ trunk/docs/user-manual/en/modules/flow-control.xml	2009-05-19 14:31:16 UTC (rev 6888)
@@ -76,7 +76,7 @@
             in-between. In that case, setting the value of <literal>consumer-window-size</literal>
             to optimize performance depends on the messaging use case and requires benchmarks to
             find the optimal value. </para>
-         <section>
+         <section id="flow-control.core.api">
             <title>Using Core API</title>
             <para>If JBoss Messaging Core API is used, the consumer window size is specified by
                   <literal>ClientSessionFactory.setConsumerWindowSize()</literal> method and some of
@@ -118,7 +118,7 @@
             consumption rate specified in units of messages per second. Setting this to <literal
                >-1</literal> disables rate limited flow control. The default value is <literal
                >-1</literal>.</para>
-         <section>
+         <section id="flow-control.rate.core.api">
             <title>Using Core API</title>
             <para>If the JBoss Messaging core API is being used the rate can be set via the <literal
                   >ClientSessionFactory.setConsumerMaxRate(int consumerMaxRate)</literal> method or
@@ -176,7 +176,7 @@
             consumption rate specified in units of messages per second. Setting this to <literal
                >-1</literal> disables rate limited flow control. The default value is <literal
                >-1</literal>.</para>
-         <section>
+         <section id="flow-control.producer.rate.core.api">
             <title>Using Core API</title>
             <para>If the JBoss Messaging core API is being used the rate can be set via the <literal
                   >ClientSessionFactory.setProducerMaxRate(int consumerMaxRate)</literal> method or

Modified: trunk/docs/user-manual/en/modules/large-messages.xml
===================================================================
--- trunk/docs/user-manual/en/modules/large-messages.xml	2009-05-19 14:20:15 UTC (rev 6887)
+++ trunk/docs/user-manual/en/modules/large-messages.xml	2009-05-19 14:31:16 UTC (rev 6888)
@@ -35,7 +35,7 @@
             its size is greater than 10KB and another one on the socket transport considering
             messages greater than 200KB as large.</para>
         <para>By default the min large message size is 100KB.</para>
-        <section>
+        <section id="large-messages.core.config">
             <title>Using Core API</title>
             <para>If the JBoss Messaging Core API is used, the minimal large message size is
                 specified by <literal>ClientSessionFactory.setMinLargeMessageSize</literal>.</para>

Modified: trunk/docs/user-manual/en/modules/send-guarantees.xml
===================================================================
--- trunk/docs/user-manual/en/modules/send-guarantees.xml	2009-05-19 14:20:15 UTC (rev 6887)
+++ trunk/docs/user-manual/en/modules/send-guarantees.xml	2009-05-19 14:31:16 UTC (rev 6888)
@@ -71,7 +71,7 @@
             and the server has a guarantee that the data has been persisted to disk. The default
             value for this parameter is <literal>false</literal>.</para>
     </section>
-    <section>
+    <section id="send-guarantees.nontrans.acks">
         <title>Guarantees of Non Transactional Acknowledgements</title>
         <para>If you are acknowledging the delivery of a message at the client side using a non
             transacted session, JBoss Messaging can be configured to block the call to acknowledge




More information about the jboss-cvs-commits mailing list