[jboss-cvs] JBoss Messaging SVN: r6890 - trunk/docs/user-manual/en/modules.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Tue May 19 10:53:24 EDT 2009
Author: ataylor
Date: 2009-05-19 10:53:24 -0400 (Tue, 19 May 2009)
New Revision: 6890
Modified:
trunk/docs/user-manual/en/modules/configuration-index.xml
Log:
added description to reference
Modified: trunk/docs/user-manual/en/modules/configuration-index.xml
===================================================================
--- trunk/docs/user-manual/en/modules/configuration-index.xml 2009-05-19 14:37:48 UTC (rev 6889)
+++ trunk/docs/user-manual/en/modules/configuration-index.xml 2009-05-19 14:53:24 UTC (rev 6890)
@@ -472,165 +472,170 @@
<entry><link linkend="clusters-discovery.groups.clientside"
>discoveryRefreshTimeout</link></entry>
<entry>long</entry>
- <entry/>
+ <entry>The timeout, in milli seconds, to when discovering. </entry>
<entry>10000</entry>
</row>
<row>
<entry><link linkend="dead.connections">pingPeriod</link></entry>
<entry>long</entry>
- <entry/>
+ <entry>The period, in milli seconds, </entry>
<entry>1000000</entry>
</row>
<row>
<entry><link linkend="dead.connections">connectionTTL</link></entry>
<entry>long</entry>
- <entry/>
+ <entry>The time to live for connections</entry>
<entry>5 * 60000</entry>
</row>
<row>
<entry>callTimeout</entry>
<entry>long</entry>
- <entry/>
+ <entry>the time out, in milliseconds, for remote calls</entry>
<entry>30000</entry>
</row>
<row>
<entry><link linkend="connection-ttl.session.multiplexing"
>maxConnections</link></entry>
<entry>int</entry>
- <entry/>
+ <entry>The max number of connections per factory</entry>
<entry>8</entry>
</row>
<row>
<entry><link linkend="large-messages.core.config"
>minLargeMessageSize</link></entry>
<entry>int</entry>
- <entry/>
+ <entry>The size, in bytes, before a message is treated as large </entry>
<entry>100 * 1024</entry>
</row>
<row>
<entry><link linkend="flow-control.core.api"
>consumerWindowSize</link></entry>
<entry>int</entry>
- <entry/>
+ <entry>The window size, in bytes, for consumer flow control</entry>
<entry>1024 * 1024</entry>
</row>
<row>
<entry><link linkend="flow-control.rate.core.api"
>consumerMaxRate</link></entry>
<entry>int</entry>
- <entry/>
+ <entry>The fastest rate a consumer may consume messages per
+ second</entry>
<entry>-1</entry>
</row>
<row>
<entry>producerWindowSize</entry>
<entry>int</entry>
- <entry/>
+ <entry>The window size for sending messages</entry>
<entry>1024 * 1024</entry>
</row>
<row>
<entry><link linkend="flow-control.producer.rate.core.api"
>producerMaxRate</link></entry>
<entry>int</entry>
- <entry/>
+ <entry>The max messages per second that can be sent</entry>
<entry>-1</entry>
</row>
<row>
<entry><link linkend="send-guarantees.nontrans.acks"
>blockOnAcknowledge</link></entry>
<entry>boolean</entry>
- <entry/>
+ <entry>Whether or not we acknowledge messages synchronously</entry>
<entry>false</entry>
</row>
<row>
<entry><link linkend="non-transactional-sends"
>blockOnPersistentSend</link></entry>
<entry>boolean</entry>
- <entry/>
+ <entry>Whether or not we send persistent messages synchronously</entry>
<entry>false</entry>
</row>
<row>
<entry><link linkend="non-transactional-sends"
>blockOnNonPersistentSend</link></entry>
<entry>boolean</entry>
- <entry/>
+ <entry>Whether or not we send non persistent messages
+ synchronously</entry>
<entry>false</entry>
</row>
<row>
<entry>autoGroup</entry>
<entry>boolean</entry>
- <entry/>
+ <entry>Whether or not we auto group on queues</entry>
<entry>false</entry>
</row>
<row>
<entry>preAcknowledge</entry>
<entry>boolean</entry>
- <entry/>
+ <entry>Whether messages are pre acknowledged by the server before
+ sending</entry>
<entry>false</entry>
</row>
<row>
<entry>ackBatchSize</entry>
<entry>int</entry>
- <entry/>
+ <entry>The batch size for sending acknowledgements</entry>
<entry>1024 * 1024</entry>
</row>
<row>
<entry><link linkend="clusters.client.loadbalancing"
>loadBalancingPolicyClassName</link></entry>
<entry>String</entry>
- <entry/>
+ <entry>The name of the load balancing class</entry>
<entry>org.jboss.messaging.core.client.impl.RoundRobinConnectionLoadBalancingPolicy</entry>
</row>
<row>
<entry><link linkend="clusters-discovery.groups.clientside"
>initialWaitTimeout</link></entry>
<entry>long</entry>
- <entry/>
+ <entry>The initail time to wait, in milli seconds, for discovery groups
+ to wait for broadcasts</entry>
<entry>2000</entry>
</row>
<row>
<entry><link linkend="thread-pooling.client.side"
>useGlobalPools</link></entry>
<entry>boolean</entry>
- <entry/>
+ <entry>Use a global thread pool for threads</entry>
<entry>true</entry>
</row>
<row>
<entry><link linkend="thread-pooling.client.side"
>scheduledThreadPoolMaxSize</link></entry>
<entry>int</entry>
- <entry/>
+ <entry>The size of the scheduled thread pool</entry>
<entry>2</entry>
</row>
<row>
<entry><link linkend="thread-pooling.client.side"
>threadPoolMaxSize</link></entry>
<entry>int</entry>
- <entry/>
+ <entry>The size of the thread pool</entry>
<entry>-1</entry>
</row>
<row>
<entry>retryInterval</entry>
<entry>long</entry>
- <entry/>
+ <entry>The time, in milliseconds, retry a connection after
+ failing</entry>
<entry>2000</entry>
</row>
<row>
<entry>retryIntervalMultiplier</entry>
<entry>double</entry>
- <entry/>
+ <entry>Used in the calculating the retry interval</entry>
<entry>1d</entry>
</row>
<row>
<entry>reconnectAttempts</entry>
<entry>int</entry>
- <entry/>
+ <entry>The number of attempts to make at reconnecting</entry>
<entry>0</entry>
</row>
<row>
<entry><link linkend="ha.client.automatic"
>failoverOnServerShutdown</link></entry>
<entry>boolean</entry>
- <entry/>
+ <entry>whether or not to failover on server shutdown</entry>
<entry>false</entry>
</row>
</tbody>
More information about the jboss-cvs-commits
mailing list