[jboss-cvs] JBoss Messaging SVN: r7234 - trunk/docs/user-manual/en.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Sun Jun 7 03:47:00 EDT 2009
Author: timfox
Date: 2009-06-07 03:47:00 -0400 (Sun, 07 Jun 2009)
New Revision: 7234
Modified:
trunk/docs/user-manual/en/configuration-index.xml
trunk/docs/user-manual/en/perf-tuning.xml
trunk/docs/user-manual/en/persistence.xml
Log:
docs tweaks
Modified: trunk/docs/user-manual/en/configuration-index.xml
===================================================================
--- trunk/docs/user-manual/en/configuration-index.xml 2009-06-07 07:11:45 UTC (rev 7233)
+++ trunk/docs/user-manual/en/configuration-index.xml 2009-06-07 07:47:00 UTC (rev 7234)
@@ -25,12 +25,57 @@
</thead>
<tbody>
<row>
+ <entry><link linkend="configuring.live.backup">backup</link></entry>
+ <entry>Boolean</entry>
+ <entry>true means that this server is a backup to another node in the
+ cluster</entry>
+ <entry>false</entry>
+ </row>
+ <row>
+ <entry><link linkend="configuring.live.backup"
+ >backup-connector-ref</link></entry>
+ <entry>String</entry>
+ <entry>the name of the remoting connector to connect to the backup
+ node</entry>
+ <entry/>
+ </row>
+ <row>
+ <entry><link linkend="configuring.bindings.journal"
+ >bindings-directory</link></entry>
+ <entry>String</entry>
+ <entry>the directory to store the persisted bindings to</entry>
+ <entry>data/bindings</entry>
+ </row>
+ <row>
<entry><link linkend="clusters">clustered</link></entry>
<entry>Boolean</entry>
<entry>true means that the server is clustered</entry>
<entry>false</entry>
</row>
<row>
+ <entry><link linkend="connection-ttl"
+ >connection-ttl-override</link></entry>
+ <entry>Long</entry>
+ <entry>if set, this will override how long (in ms) to keep a connection
+ alive without receiving a ping. </entry>
+ <entry>-1</entry>
+ </row>
+ <row>
+ <entry><link linkend="configuring.bindings.journal"
+ >create-bindings-dir</link></entry>
+ <entry>Boolean</entry>
+ <entry>true means that the server will create the bindings directory on
+ start up</entry>
+ <entry>true</entry>
+ </row>
+ <row>
+ <entry><link linkend="configuring.message.journal.create-journal-dir"
+ >create-journal-dir</link></entry>
+ <entry>Boolean</entry>
+ <entry>true means that the journal directory will be created</entry>
+ <entry>true</entry>
+ </row>
+ <row>
<entry><link linkend="using-server.configuration"
>file-deployment-enabled</link></entry>
<entry>Boolean</entry>
@@ -39,193 +84,182 @@
<entry>true</entry>
</row>
<row>
- <entry><link linkend="persistence.enabled"
- >persistence-enabled</link></entry>
- <entry>Boolean</entry>
- <entry>true means that the server will use the file based journal for
- persistence.</entry>
- <entry>true</entry>
+ <entry><link linkend="paging.main.config"
+ >global-page-size</link></entry>
+ <entry>Long</entry>
+ <entry>the standard size (in bytes) of a page-file. JBoss Messaging will
+ only read messages when there is enough space to read at least one
+ page file, determined by this value.</entry>
+ <entry>10 * 1024 * 1024</entry>
</row>
<row>
- <entry><link linkend="server.scheduled.thread.pool"
- >scheduled-thread-pool-max-size</link></entry>
+ <entry><link linkend="duplicate.id.cache">id-cache-size</link></entry>
<entry>Integer</entry>
- <entry>the number of threads that the main scheduled thread pool
- has.</entry>
- <entry>5</entry>
+ <entry>the size of the cache for pre creating message id's</entry>
+ <entry>2000</entry>
</row>
<row>
- <entry><link linkend="server.scheduled.thread.pool"
- >thread-pool-max-size</link></entry>
+ <entry><link
+ linkend="configuring.message.journal.journal-aio-buffer-size"
+ >journal-aio-buffer-size</link></entry>
+ <entry>Long</entry>
+ <entry>The size of the internal buffer on AIO.</entry>
+ <entry>128 KiB</entry>
+ </row>
+ <row>
+ <entry><link
+ linkend="configuring.message.journal.journal-aio-buffer-timeout"
+ >journal-aio-buffer-timeout</link></entry>
+ <entry>Long</entry>
+ <entry>The timeout (in nanoseconds) used to flush internal buffers.</entry>
+ <entry>20000</entry>
+ </row>
+ <row>
+ <entry><link
+ linkend="configuring.message.journal.journal-aio-flush-on-sync"
+ >journal-aio-flush-on-sync</link></entry>
+ <entry>Boolean</entry>
+ <entry>If true, transactions will ignore timeouts and be persisted
+ immediately</entry>
+ <entry>False</entry>
+ </row>
+ <row>
+ <entry><link linkend="configuring.message.journal.journal-directory"
+ >journal-directory</link></entry>
+ <entry>String</entry>
+ <entry>the directory to store the journal files in</entry>
+ <entry>data/journal</entry>
+ </row>
+ <row>
+ <entry><link linkend="configuring.message.journal.journal-file-size"
+ >journal-file-size</link></entry>
+ <entry>Long</entry>
+ <entry>the size (in bytes) of each journal file</entry>
+ <entry>128 * 1024</entry>
+ </row>
+ <row>
+ <entry><link linkend="configuring.message.journal.journal-max-aio"
+ >journal-max-aio</link></entry>
<entry>Integer</entry>
- <entry>the number of threads that the main thread pool has. -1 means no
- limit</entry>
- <entry>-1</entry>
+ <entry>the maximum number of write requests that can be in the AIO queue
+ at any one time</entry>
+ <entry>5000</entry>
</row>
<row>
- <entry><link linkend="security">security-enabled</link></entry>
+ <entry><link linkend="configuring.message.journal.journal-min-files"
+ >journal-min-files</link></entry>
+ <entry>Integer</entry>
+ <entry>how many journal files to pre-create</entry>
+ <entry>2</entry>
+ </row>
+ <row>
+ <entry><link
+ linkend="configuring.message.journal.journal-sync-transactional"
+ >journal-sync-transactional</link></entry>
<entry>Boolean</entry>
- <entry>true means that security is enabled</entry>
+ <entry>if true wait for transaction data to be synchronized to the
+ journal before returning response to client</entry>
<entry>true</entry>
</row>
<row>
- <entry><link linkend="security"
- >security-invalidation-interval</link></entry>
- <entry>Long</entry>
- <entry>how long (in ms) to wait before invalidating the security
- cache</entry>
- <entry>10000</entry>
+ <entry><link
+ linkend="configuring.message.journal.journal-sync-non-transactional"
+ >journal-sync-non-transactional</link></entry>
+ <entry>Boolean</entry>
+ <entry>if true wait for non transaction data to be synced to the journal
+ before returning response to client.</entry>
+ <entry>false</entry>
</row>
<row>
- <entry><link linkend="wildcard-routing"
- >wild-card-routing-enabled</link></entry>
+ <entry><link linkend="configuring.message.journal.journal-type"
+ >journal-type</link></entry>
+ <entry>ASYNCIO|NIO</entry>
+ <entry>the type of journal to use</entry>
+ <entry>ASYNCIO</entry>
+ </row>
+ <row>
+ <entry><link linkend="management.jmx.configuration"
+ >jmx-management-enabled</link></entry>
<entry>Boolean</entry>
- <entry>true means that the server supports wild card routing</entry>
+ <entry>true means that the management API is available via JMX</entry>
<entry>true</entry>
</row>
<row>
+ <entry><link linkend="large.message.configuring"
+ >large-messages-directory</link></entry>
+ <entry>String</entry>
+ <entry>the directory to store large messages</entry>
+ <entry>data/largemessages</entry>
+ </row>
+ <row>
<entry><link linkend="management.core.configuration"
- >management-address</link></entry>
+ >management-address</link></entry>
<entry>String</entry>
<entry>the name of the management address to send management messages
to</entry>
<entry>jbm.management</entry>
</row>
<row>
+ <entry><link linkend="management.replication"
+ >management-cluster-password</link></entry>
+ <entry>String</entry>
+ <entry>the password used to for replicating management operations
+ between clustered nodes</entry>
+ <entry>CHANGE ME!!</entry>
+ </row>
+ <row>
<entry><link linkend="management.notifications.core.configuration"
- >management-notification-address</link></entry>
+ >management-notification-address</link></entry>
<entry>String</entry>
<entry>the name of the address that consumers bind to receive management
notifications</entry>
<entry>jbm.notifications</entry>
</row>
+
<row>
<entry><link linkend="management.replication"
- >management-cluster-password</link></entry>
- <entry>String</entry>
- <entry>the password used to for replicating management operations
- between clustered nodes</entry>
- <entry>CHANGE ME!!</entry>
- </row>
- <row>
- <entry><link linkend="management.replication"
- >management-request-timeout</link></entry>
+ >management-request-timeout</link></entry>
<entry>Long</entry>
<entry>how long (in ms) to wait for a reply to a management
request</entry>
<entry>5000</entry>
</row>
<row>
- <entry><link linkend="management.jmx.configuration"
- >jmx-management-enabled</link></entry>
- <entry>Boolean</entry>
- <entry>true means that the management API is available via JMX</entry>
- <entry>true</entry>
- </row>
- <row>
<entry><link linkend="configuring.message.counters"
- >message-counter-enabled</link></entry>
+ >message-counter-enabled</link></entry>
<entry>Boolean</entry>
<entry>true means that message counters are enabled</entry>
<entry>false</entry>
</row>
<row>
<entry><link linkend="configuring.message.counters"
- >message-counter-sample-period</link></entry>
- <entry>Long</entry>
- <entry>the sample period (in ms) to use for message counters</entry>
- <entry>10000</entry>
- </row>
- <row>
- <entry><link linkend="configuring.message.counters"
- >message-counter-max-day-history</link></entry>
+ >message-counter-max-day-history</link></entry>
<entry>Integer</entry>
<entry>how many days to keep message counter history</entry>
<entry>10</entry>
</row>
<row>
- <entry><link linkend="dead.connections"
- >connection-ttl-override</link></entry>
+ <entry><link linkend="configuring.message.counters"
+ >message-counter-sample-period</link></entry>
<entry>Long</entry>
- <entry>if set, this will override how long (in ms) to keep a connection
- alive without receiving a ping. </entry>
- <entry>-1</entry>
+ <entry>the sample period (in ms) to use for message counters</entry>
+ <entry>10000</entry>
</row>
<row>
- <entry><link linkend="transaction-config"
- >transaction-timeout</link></entry>
- <entry>Long</entry>
- <entry>how long (in ms) before a transaction can be removed from the
- resource manager after create time</entry>
- <entry>60000</entry>
- </row>
- <row>
- <entry><link linkend="transaction-config"
- >transaction-timeout-scan-period</link></entry>
- <entry>Long</entry>
- <entry>how often (in ms) to scan for timeout transactions</entry>
- <entry>1000</entry>
- </row>
- <row>
<entry><link linkend="configuring.expiry.reaper"
- >message-expiry-scan-period</link></entry>
+ >message-expiry-scan-period</link></entry>
<entry>Long</entry>
<entry>how often (in ms) to scan for expired messages</entry>
<entry>30000</entry>
</row>
<row>
<entry><link linkend="configuring.expiry.reaper"
- >message-expiry-thread-priority</link></entry>
+ >message-expiry-thread-priority</link></entry>
<entry>Integer</entry>
<entry>the priority of the thread expiring messages</entry>
<entry>3</entry>
</row>
<row>
- <entry><link linkend="duplicate.id.cache">id-cache-size</link></entry>
- <entry>Integer</entry>
- <entry>the size of the cache for pre creating message id's</entry>
- <entry>2000</entry>
- </row>
- <row>
- <entry><link linkend="duplicate.id.cache"
- >persist-id-cache</link></entry>
- <entry>Boolean</entry>
- <entry>true means that id's are persisted to the journal</entry>
- <entry>true</entry>
- </row>
- <row>
- <entry><link linkend="queue.activation.timeout"
- >queue-activation-timeout</link></entry>
- <entry>Long</entry>
- <entry>after failover occurs, this timeout specifies how long (in ms) to
- wait for consumers to re-attach before starting delivery</entry>
- <entry>30000</entry>
- </row>
- <row>
- <entry><link linkend="configuring.live.backup">backup</link></entry>
- <entry>Boolean</entry>
- <entry>true means that this server is a backup to another node in the
- cluster</entry>
- <entry>false</entry>
- </row>
- <row>
- <entry><link linkend="configuring.delivery.count.persistence">
- persist-delivery-count-before-delivery</link></entry>
- <entry>Boolean</entry>
- <entry>true means that the delivery count is persisted before delivery.
- False means that this only happens after a message has been
- cancelled.</entry>
- <entry>false</entry>
- </row>
- <row>
- <entry><link linkend="configuring.live.backup"
- >backup-connector-ref</link></entry>
- <entry>String</entry>
- <entry>the name of the remoting connector to connect to the backup
- node</entry>
- <entry/>
- </row>
- <row>
<entry><link linkend="paging.main.config"
>paging-directory</link></entry>
<entry>String</entry>
@@ -234,136 +268,121 @@
</row>
<row>
<entry><link linkend="paging.main.config"
- >global-page-size</link></entry>
+ >paging-max-global-size-bytes</link></entry>
<entry>Long</entry>
- <entry>the standard size (in bytes) of a page-file. JBoss Messaging will
- only read messages when there is enough space to read at least one
- page file, determined by this value.</entry>
- <entry>10 * 1024 * 1024</entry>
- </row>
- <row>
- <entry><link linkend="paging.main.config"
- >paging-max-global-size-bytes</link></entry>
- <entry>Long</entry>
<entry>JBoss Messaging enters into global page mode as soon as the total
memory consumed by messages hits this value (in bytes)</entry>
<entry>-1</entry>
</row>
<row>
- <entry><link linkend="configuring.bindings.journal"
- >bindings-directory</link></entry>
- <entry>String</entry>
- <entry>the directory to store the persisted bindings to</entry>
- <entry>data/bindings</entry>
+ <entry><link linkend="configuring.delivery.count.persistence">
+ persist-delivery-count-before-delivery</link></entry>
+ <entry>Boolean</entry>
+ <entry>true means that the delivery count is persisted before delivery.
+ False means that this only happens after a message has been
+ cancelled.</entry>
+ <entry>false</entry>
</row>
<row>
- <entry><link linkend="configuring.bindings.journal"
- >create-bindings-dir</link></entry>
+ <entry><link linkend="persistence.enabled"
+ >persistence-enabled</link></entry>
<entry>Boolean</entry>
- <entry>true means that the server will create the bindings directory on
- start up</entry>
+ <entry>true means that the server will use the file based journal for
+ persistence.</entry>
<entry>true</entry>
</row>
<row>
- <entry><link linkend="configuring.message.journal.journal-directory"
- >journal-directory</link></entry>
- <entry>String</entry>
- <entry>the directory to store the journal files in</entry>
- <entry>data/journal</entry>
- </row>
- <row>
- <entry><link linkend="configuring.message.journal.create-journal-dir"
- >create-journal-dir</link></entry>
+ <entry><link linkend="duplicate.id.cache"
+ >persist-id-cache</link></entry>
<entry>Boolean</entry>
- <entry>true means that the journal directory will be created</entry>
+ <entry>true means that id's are persisted to the journal</entry>
<entry>true</entry>
</row>
<row>
- <entry><link linkend="configuring.message.journal.journal-type"
- >journal-type</link></entry>
- <entry>ASYNCIO|NIO</entry>
- <entry>the type of journal to use</entry>
- <entry>ASYNCIO</entry>
- </row>
- <row>
- <entry><link
- linkend="configuring.message.journal.journal-aio-buffer-timeout"
- >journal-aio-buffer-timeout</link></entry>
+ <entry><link linkend="queue.activation.timeout"
+ >queue-activation-timeout</link></entry>
<entry>Long</entry>
- <entry>The timeout (in nanoseconds) used to flush internal buffers.</entry>
- <entry>20000</entry>
+ <entry>after failover occurs, this timeout specifies how long (in ms) to
+ wait for consumers to re-attach before starting delivery</entry>
+ <entry>30000</entry>
</row>
<row>
- <entry><link
- linkend="configuring.message.journal.journal-aio-flush-on-sync"
- >journal-aio-flush-on-sync</link></entry>
- <entry>Boolean</entry>
- <entry>If true, transactions will ignore timeouts and be persisted
- immediately</entry>
- <entry>False</entry>
+ <entry><link linkend="server.scheduled.thread.pool"
+ >scheduled-thread-pool-max-size</link></entry>
+ <entry>Integer</entry>
+ <entry>the number of threads that the main scheduled thread pool
+ has.</entry>
+ <entry>5</entry>
</row>
<row>
- <entry><link
- linkend="configuring.message.journal.journal-aio-buffer-size"
- >journal-aio-buffer-size</link></entry>
- <entry>Long</entry>
- <entry>The size of the internal buffer on AIO.</entry>
- <entry>128 KiB</entry>
- </row>
- <row>
- <entry><link
- linkend="configuring.message.journal.journal-sync-transactional"
- >journal-sync-transactional</link></entry>
+ <entry><link linkend="security">security-enabled</link></entry>
<entry>Boolean</entry>
- <entry>if true wait for transaction data to be synchronized to the
- journal before returning response to client</entry>
+ <entry>true means that security is enabled</entry>
<entry>true</entry>
</row>
<row>
- <entry><link
- linkend="configuring.message.journal.journal-sync-non-transactional"
- >journal-sync-non-transactional</link></entry>
- <entry>Boolean</entry>
- <entry>if true wait for non transaction data to be synced to the journal
- before returning response to client.</entry>
- <entry>false</entry>
- </row>
- <row>
- <entry><link linkend="configuring.message.journal.journal-file-size"
- >journal-file-size</link></entry>
+ <entry><link linkend="security"
+ >security-invalidation-interval</link></entry>
<entry>Long</entry>
- <entry>the size (in bytes) of each journal file</entry>
- <entry>128 * 1024</entry>
+ <entry>how long (in ms) to wait before invalidating the security
+ cache</entry>
+ <entry>10000</entry>
</row>
<row>
- <entry><link linkend="configuring.message.journal.journal-min-files"
- >journal-min-files</link></entry>
+ <entry><link linkend="server.scheduled.thread.pool"
+ >thread-pool-max-size</link></entry>
<entry>Integer</entry>
- <entry>how many journal files to pre-create</entry>
- <entry>2</entry>
+ <entry>the number of threads that the main thread pool has. -1 means no
+ limit</entry>
+ <entry>-1</entry>
</row>
<row>
- <entry><link linkend="configuring.message.journal.journal-max-aio"
- >journal-max-aio</link></entry>
- <entry>Integer</entry>
- <entry>the maximum number of write requests that can be in the AIO queue
- at any one time</entry>
- <entry>5000</entry>
+ <entry><link linkend="transaction-config"
+ >transaction-timeout</link></entry>
+ <entry>Long</entry>
+ <entry>how long (in ms) before a transaction can be removed from the
+ resource manager after create time</entry>
+ <entry>60000</entry>
</row>
<row>
- <entry><link linkend="large.message.configuring"
- >large-messages-directory</link></entry>
- <entry>String</entry>
- <entry>the directory to store large messages</entry>
- <entry>data/largemessages</entry>
+ <entry><link linkend="transaction-config"
+ >transaction-timeout-scan-period</link></entry>
+ <entry>Long</entry>
+ <entry>how often (in ms) to scan for timeout transactions</entry>
+ <entry>1000</entry>
</row>
+
<row>
- <entry><link linkend="understanding.connectors"
- >connectors</link></entry>
- <entry>Connector</entry>
- <entry>a list of remoting connectors configurations to create</entry>
- <entry/>
+ <entry><link linkend="wildcard-routing"
+ >wild-card-routing-enabled</link></entry>
+ <entry>Boolean</entry>
+ <entry>true means that the server supports wild card routing</entry>
+ <entry>true</entry>
</row>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<row>
<entry><link linkend="configuring-transports.acceptors"
>acceptors</link></entry>
@@ -379,6 +398,15 @@
<entry/>
</row>
<row>
+ <entry><link linkend="understanding.connectors"
+ >connectors</link></entry>
+ <entry>Connector</entry>
+ <entry>a list of remoting connectors configurations to create</entry>
+ <entry/>
+ </row>
+
+
+ <row>
<entry><link linkend="clusters.discovery-groups"
>discovery-groups</link></entry>
<entry>DiscoveryGroup</entry>
@@ -781,194 +809,208 @@
<entry/>
</row>
<row>
- <entry><link linkend="using-jms.clientid"
- >connection-factory.client-id</link></entry>
- <entry>String</entry>
- <entry>the pre-configured client ID for the connection factory</entry>
- <entry>null</entry>
+ <entry><link linkend="message-grouping.jmsconfigure"
+ >connection-factory.auto-group</link></entry>
+ <entry>Boolean</entry>
+ <entry>whether or not message grouping is automatically used</entry>
+ <entry>false</entry>
</row>
<row>
- <entry><link linkend="dead.connections"
- >connection-factory.client-failure-check-period</link></entry>
- <entry>Long</entry>
- <entry>the period (in ms) after which the client will consider the
- connection failed after not receiving packets from the
- server</entry>
- <entry>5000</entry>
+ <entry><link linkend="send-guarantees.nontrans.acks"
+ >connection-factory.block-on-acknowledge</link></entry>
+ <entry>Boolean</entry>
+ <entry>whether or not messages are acknowledged synchronously</entry>
+ <entry>false</entry>
</row>
<row>
- <entry><link linkend="dead.connections"
- >connection-factory.connection-ttl</link></entry>
- <entry>Long</entry>
- <entry>the time to live (in ms) for connections</entry>
- <entry>5 * 60000</entry>
+ <entry><link linkend="non-transactional-sends"
+ >connection-factory.block-on-non-persistent-send</link></entry>
+ <entry>Boolean</entry>
+ <entry>whether or not non persistent messages are sent
+ synchronously</entry>
+ <entry>false</entry>
</row>
<row>
+ <entry><link linkend="non-transactional-sends"
+ >connection-factory.block-on-persistent-send</link></entry>
+ <entry>Boolean</entry>
+ <entry>whether or not persistent messages are sent synchronously</entry>
+ <entry>false</entry>
+ </row>
+ <row>
<entry>connection-factory.call-timeout</entry>
<entry>Long</entry>
<entry>the timeout (in ms) for remote calls</entry>
<entry>30000</entry>
</row>
<row>
- <entry><link linkend="connection-ttl.session.multiplexing"
- >connection-factory.max-connections</link></entry>
- <entry>Integer</entry>
- <entry>the maximum number of connections per factory</entry>
- <entry>8</entry>
+ <entry><link linkend="dead.connections"
+ >connection-factory.client-failure-check-period</link></entry>
+ <entry>Long</entry>
+ <entry>the period (in ms) after which the client will consider the
+ connection failed after not receiving packets from the
+ server</entry>
+ <entry>5000</entry>
</row>
<row>
- <entry><link linkend="large-messages.core.config"
- >connection-factory.min-large-message-size</link></entry>
- <entry>Integer</entry>
- <entry>the size (in bytes) before a message is treated as large </entry>
- <entry>100 * 1024</entry>
+ <entry><link linkend="using-jms.clientid"
+ >connection-factory.client-id</link></entry>
+ <entry>String</entry>
+ <entry>the pre-configured client ID for the connection factory</entry>
+ <entry>null</entry>
</row>
<row>
- <entry><link linkend="flow-control.core.api"
- >connection-factory.consumer-window-size</link></entry>
- <entry>Integer</entry>
- <entry>the window size (in bytes) for consumer flow control</entry>
- <entry>1024 * 1024</entry>
+ <entry><link linkend="clusters.client.loadbalancing"
+ >connection-factory.connection-load-balancing-policy-class-name</link></entry>
+ <entry>String</entry>
+ <entry>the name of the load balancing class</entry>
+ <entry>org.jboss.messaging.core.client.impl.RoundRobinConnectionLoadBalancingPolicy</entry>
</row>
<row>
+ <entry><link linkend="dead.connections"
+ >connection-factory.connection-ttl</link></entry>
+ <entry>Long</entry>
+ <entry>the time to live (in ms) for connections</entry>
+ <entry>5 * 60000</entry>
+ </row>
+ <row>
<entry><link linkend="flow-control.rate.core.api"
- >connection-factory.consumer-max-rate</link></entry>
+ >connection-factory.consumer-max-rate</link></entry>
<entry>Integer</entry>
<entry>the fastest rate a consumer may consume messages per
second</entry>
<entry>-1</entry>
</row>
<row>
- <entry><link linkend="command-buffering"
- >connection-factory.producer-window-size</link></entry>
+ <entry><link linkend="flow-control.core.api"
+ >connection-factory.consumer-window-size</link></entry>
<entry>Integer</entry>
- <entry>the window size (in bytes) for sending messages</entry>
+ <entry>the window size (in bytes) for consumer flow control</entry>
<entry>1024 * 1024</entry>
</row>
<row>
- <entry><link linkend="flow-control.producer.rate.core.api"
- >connection-factory.producer-max-rate</link></entry>
- <entry>Integer</entry>
- <entry>the maximum rate of messages per second that can be sent</entry>
- <entry>-1</entry>
+ <entry><link linkend="clusters-discovery.groups.clientside"
+ >connection-factory.discovery-initial-wait-timeout</link></entry>
+ <entry>Long</entry>
+ <entry>the initial time to wait (in ms) for discovery groups to wait for
+ broadcasts</entry>
+ <entry>2000</entry>
</row>
<row>
- <entry><link linkend="send-guarantees.nontrans.acks"
- >connection-factory.block-on-acknowledge</link></entry>
- <entry>Boolean</entry>
- <entry>whether or not messages are acknowledged synchronously</entry>
- <entry>false</entry>
+ <entry><link linkend="using-jms.dupsokbatchsize"
+ >connection-factory.dups-ok-batch-size</link></entry>
+ <entry>Integer</entry>
+ <entry>the batch size (in bytes) between acknowledgements when using
+ DUPS_OK_ACKNOWLEDGE mode</entry>
+ <entry>1024 * 1024</entry>
</row>
<row>
- <entry><link linkend="non-transactional-sends"
- >connection-factory.block-on-non-persistent-send</link></entry>
+ <entry><link linkend="ha.client.automatic"
+ >connection-factory.failover-on-server-shutdown</link></entry>
<entry>Boolean</entry>
- <entry>whether or not non persistent messages are sent
- synchronously</entry>
+ <entry>whether or not to failover on server shutdown</entry>
<entry>false</entry>
</row>
<row>
- <entry><link linkend="non-transactional-sends"
- >connection-factory.block-on-persistent-send</link></entry>
- <entry>Boolean</entry>
- <entry>whether or not persistent messages are sent synchronously</entry>
- <entry>false</entry>
+ <entry><link linkend="connection-ttl.session.multiplexing"
+ >connection-factory.max-connections</link></entry>
+ <entry>Integer</entry>
+ <entry>the maximum number of connections per factory</entry>
+ <entry>8</entry>
</row>
<row>
- <entry><link linkend="message-grouping.jmsconfigure"
- >connection-factory.auto-group</link></entry>
- <entry>Boolean</entry>
- <entry>whether or not message grouping is automatically used</entry>
- <entry>false</entry>
+ <entry><link linkend="large-messages.core.config"
+ >connection-factory.min-large-message-size</link></entry>
+ <entry>Integer</entry>
+ <entry>the size (in bytes) before a message is treated as large </entry>
+ <entry>100 * 1024</entry>
</row>
<row>
<entry><link linkend="pre-acknowledge.configure"
- >connection-factory.pre-acknowledge</link></entry>
+ >connection-factory.pre-acknowledge</link></entry>
<entry>Boolean</entry>
<entry>whether messages are pre acknowledged by the server before
sending</entry>
<entry>false</entry>
</row>
<row>
- <entry><link linkend="using-jms.dupsokbatchsize"
- >connection-factory.dups-ok-batch-size</link></entry>
+ <entry><link linkend="flow-control.producer.rate.core.api"
+ >connection-factory.producer-max-rate</link></entry>
<entry>Integer</entry>
- <entry>the batch size (in bytes) between acknowledgements when using
- DUPS_OK_ACKNOWLEDGE mode</entry>
- <entry>1024 * 1024</entry>
+ <entry>the maximum rate of messages per second that can be sent</entry>
+ <entry>-1</entry>
</row>
<row>
- <entry><link linkend="using-jms.txbatchsize"
- >connection-factory.transaction-batch-size</link></entry>
+ <entry><link linkend="command-buffering"
+ >connection-factory.producer-window-size</link></entry>
<entry>Integer</entry>
- <entry>the batch size (in bytes) between acknowledgements when using a
- transactional session</entry>
+ <entry>the window size (in bytes) for sending messages</entry>
<entry>1024 * 1024</entry>
</row>
<row>
- <entry><link linkend="clusters.client.loadbalancing"
- >connection-factory.connection-load-balancing-policy-class-name</link></entry>
- <entry>String</entry>
- <entry>the name of the load balancing class</entry>
- <entry>org.jboss.messaging.core.client.impl.RoundRobinConnectionLoadBalancingPolicy</entry>
+ <entry><link linkend="client-reconnection"
+ >connection-factory.reconnect-attempts</link></entry>
+ <entry>Integer</entry>
+ <entry>maximum number of retry attempts, -1 signifies infinite</entry>
+ <entry>0</entry>
</row>
<row>
- <entry><link linkend="clusters-discovery.groups.clientside"
- >connection-factory.discovery-initial-wait-timeout</link></entry>
+ <entry><link linkend="client-reconnection"
+ >connection-factory.retry-interval</link></entry>
<entry>Long</entry>
- <entry>the initial time to wait (in ms) for discovery groups to wait for
- broadcasts</entry>
+ <entry>the time (in ms) to retry a connection after failing</entry>
<entry>2000</entry>
</row>
<row>
- <entry><link linkend="thread-pooling.client.side"
- >connection-factory.use-global-pools</link></entry>
- <entry>Boolean</entry>
- <entry>whether or not to use a global thread pool for threads</entry>
- <entry>true</entry>
+ <entry><link linkend="client-reconnection"
+ >connection-factory.retry-interval-multiplier</link></entry>
+ <entry>Double</entry>
+ <entry>multiplier to apply to successive retry intervals</entry>
+ <entry>1d</entry>
</row>
<row>
<entry><link linkend="thread-pooling.client.side"
- >connection-factory.scheduled-thread-pool-max-size</link></entry>
+ >connection-factory.scheduled-thread-pool-max-size</link></entry>
<entry>Integer</entry>
<entry>the size of the scheduled thread pool</entry>
<entry>2</entry>
</row>
<row>
<entry><link linkend="thread-pooling.client.side"
- >connection-factory.thread-pool-max-size</link></entry>
+ >connection-factory.thread-pool-max-size</link></entry>
<entry>Integer</entry>
<entry>the size of the thread pool</entry>
<entry>-1</entry>
</row>
<row>
- <entry><link linkend="client-reconnection"
- >connection-factory.retry-interval</link></entry>
- <entry>Long</entry>
- <entry>the time (in ms) to retry a connection after failing</entry>
- <entry>2000</entry>
- </row>
- <row>
- <entry><link linkend="client-reconnection"
- >connection-factory.retry-interval-multiplier</link></entry>
- <entry>Double</entry>
- <entry>multiplier to apply to successive retry intervals</entry>
- <entry>1d</entry>
- </row>
- <row>
- <entry><link linkend="client-reconnection"
- >connection-factory.reconnect-attempts</link></entry>
+ <entry><link linkend="using-jms.txbatchsize"
+ >connection-factory.transaction-batch-size</link></entry>
<entry>Integer</entry>
- <entry>maximum number of retry attempts, -1 signifies infinite</entry>
- <entry>0</entry>
+ <entry>the batch size (in bytes) between acknowledgements when using a
+ transactional session</entry>
+ <entry>1024 * 1024</entry>
</row>
+
+
+
+
+
+
+
+
<row>
- <entry><link linkend="ha.client.automatic"
- >connection-factory.failover-on-server-shutdown</link></entry>
+ <entry><link linkend="thread-pooling.client.side"
+ >connection-factory.use-global-pools</link></entry>
<entry>Boolean</entry>
- <entry>whether or not to failover on server shutdown</entry>
- <entry>false</entry>
+ <entry>whether or not to use a global thread pool for threads</entry>
+ <entry>true</entry>
</row>
+
+
+
+
+
+
<row>
<entry><link linkend="using-jms.server.configuration"
>queue</link></entry>
Modified: trunk/docs/user-manual/en/perf-tuning.xml
===================================================================
--- trunk/docs/user-manual/en/perf-tuning.xml 2009-06-07 07:11:45 UTC (rev 7233)
+++ trunk/docs/user-manual/en/perf-tuning.xml 2009-06-07 07:47:00 UTC (rev 7234)
@@ -24,9 +24,8 @@
<para><literal>journal-aio-flush-on-sync</literal>. If you don't have many producers
in your system you may consider setting journal-aio-flush-on-sync to true. JBoss
Messaging by default is optimized by the case where you have many producers. We
- try to concatenate multiple writes in single OS operations. However if that's
- not your case setting this option to true will give you a performance
- boost.</para>
+ try to combine multiple writes in a single OS operation. However if that's not
+ your case setting this option to true will give you a performance boost.</para>
<para>On the other hand when you have multiple producers, keeping <literal
>journal-aio-flush-on-sync</literal> set to false. This will make your
system flush multiple syncs in a single OS call making your system scale much
Modified: trunk/docs/user-manual/en/persistence.xml
===================================================================
--- trunk/docs/user-manual/en/persistence.xml 2009-06-07 07:11:45 UTC (rev 7233)
+++ trunk/docs/user-manual/en/persistence.xml 2009-06-07 07:47:00 UTC (rev 7234)
@@ -175,16 +175,17 @@
in the AIO queue at any one time. If the queue becomes full then writes will
block until space is freed up. This parameter has no meaning when using the NIO
journal.</para>
+ <para>The default value for this is <literal>500</literal>.
+ </para>
</listitem>
<listitem id="configuring.message.journal.journal-aio-buffer-timeout">
<para><literal>journal-aio-buffer-timeout</literal></para>
- <para>Flush period on the internal AIO timed buffer, configured in nanoSeconds. For
- performance reasons we buffer data before submiting it to the kernel writes,
- however we need flush in order to complete transactions. If the system is
- inactive for more than <literal>journal-aio-buffer-timeout</literal> we flush
- the buffer and complete the transactions. Also, if there are pending
- transactions we guarantee the data is flushed up to <literal
- >journal-aio-buffer-timeout</literal>.</para>
+ <para>Flush period on the internal AIO timed buffer, configured in nano seconds. For
+ performance reasons we buffer data before submitting it to the kernel in a single batch.
+ This parameter determines the maximum amount of time to wait before flushing the buffer, if it does not get full
+ by itself in that time.</para>
+ <para>The default value for this paramater is <literal>20000</literal> nano seconds (i.e. 20 microseconds).
+ </para>
</listitem>
<listitem id="configuring.message.journal.journal-aio-flush-on-sync">
<para><literal>journal-aio-flush-on-sync</literal></para>
@@ -197,12 +198,14 @@
single OS call.</para>
<para>However in some use cases it may be better to not wait any data and just flush
and write to the OS right away. For example if you have a single producer
- writing small transactions. On this case it would be better to aways
+ writing small transactions. On this case it would be better to always
flush-on-sync.</para>
+ <para>The default value for this parameter is <literal>false</literal>.
+ </para>
</listitem>
<listitem id="configuring.message.journal.journal-aio-buffer-size">
<para><literal>journal-aio-buffer-size</literal></para>
- <para>The size of the timed buffer on AIO. The default value is 128KiB.</para>
+ <para>The size of the timed buffer on AIO. The default value is <literal>128KiB</literal>.</para>
</listitem>
</itemizedlist>
</section>
More information about the jboss-cvs-commits
mailing list