You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by bu...@apache.org on 2013/03/13 01:22:33 UTC
svn commit: r854202 - in /websites/production/activemq/content:
cache/main.pageCache connection-configuration-uri.html
Author: buildbot
Date: Wed Mar 13 00:22:33 2013
New Revision: 854202
Log:
Production update by buildbot for activemq
Modified:
websites/production/activemq/content/cache/main.pageCache
websites/production/activemq/content/connection-configuration-uri.html
Modified: websites/production/activemq/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/activemq/content/connection-configuration-uri.html
==============================================================================
--- websites/production/activemq/content/connection-configuration-uri.html (original)
+++ websites/production/activemq/content/connection-configuration-uri.html Wed Mar 13 00:22:33 2013
@@ -90,7 +90,7 @@ tcp:<span class="code-comment">//localho
<p>The following options should be prefixed with <b>jms.</b> when used on a URI when connecting to a broker.</p>
<div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Option Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> alwaysSessionAsync </td><td colspan="1" rowspan="1" class="confluenceTd"> true </td><td colspan="1" rowspan="1" class="confluenceTd"> If this flag is set then a separate thread is used for dispatching messages for each Session in the Connection. However, a separate thread is always used if there is more than one session, or the session isn't in auto acknowledge or dups ok mode </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> clientID </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td><td colspan="1" rowspan="1" class="confluenceTd"> Sets the JMS clientID to use for the connection </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> close
Timeout </td><td colspan="1" rowspan="1" class="confluenceTd"> 15000ms </td><td colspan="1" rowspan="1" class="confluenceTd"> Sets the timeout before a close is considered complete. Normally a close() on a connection waits for confirmation from the broker; this allows that operation to timeout to save the client hanging if there is no broker. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> copyMessageOnSend </td><td colspan="1" rowspan="1" class="confluenceTd"> true </td><td colspan="1" rowspan="1" class="confluenceTd"> Should a JMS message be copied to a new JMS Message object as part of the send() method in JMS. This is enabled by default to be compliant with the JMS specification. You can disable it if you do not mutate JMS messages after they are sent for a performance boost. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> disableTimeStampsByDefault </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="
1" class="confluenceTd"> Sets whether or not timestamps on messages should be disabled or not. If you disable them it adds a small performance boost. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> dispatchAsync </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> Should the broker <a shape="rect" href="consumer-dispatch-async.html" title="Consumer Dispatch Async">dispatch messages asynchronously</a> to the consumer. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> nestedMapAndListEnabled </td><td colspan="1" rowspan="1" class="confluenceTd"> true </td><td colspan="1" rowspan="1" class="confluenceTd"> Enables/disables whether or not <a shape="rect" href="structured-message-properties-and-mapmessages.html" title="Structured Message Properties and MapMessages">Structured Message Properties and MapMessages</a> are supported so that Message properties and MapMessage entries can contain
nested Map and List objects. Available since version 4.1 onwards</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> objectMessageSerializationDefered </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> When an object is set on an ObjectMessage, the JMS spec requires the object to be serialized by that set method. Enabling this flag causes the object to not get serialized. The object may subsequently get serialized if the message needs to be sent over a socket or stored to disk. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> optimizeAcknowledge </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> Enables an optimised acknowledgement mode where messages are acknowledged in batches rather than individually. Alternatively, you could use Session.DUPS_OK_ACKNOWLEDGE acknowledgement mode for the consumers which can often be f
aster. <b>WARNING</b> enabling this issue could cause some issues with auto-acknowledgement on reconnection<br clear="none" class="atl-forced-newline"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> optimizeAcknowledgeTimeOut</td><td colspan="1" rowspan="1" class="confluenceTd">300ms</td><td colspan="1" rowspan="1" class="confluenceTd">if > 0, specifies the max time between batch acks when optimizeAcknowledge is enabled. (since 5.6)</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> optimizedMessageDispatch </td><td colspan="1" rowspan="1" class="confluenceTd"> true </td><td colspan="1" rowspan="1" class="confluenceTd"> If this flag is set then an larger prefetch limit is used - only applicable for durable topic subscribers <br clear="none" class="atl-forced-newline"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> useAsyncSend </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="
confluenceTd"> Forces the use of <a shape="rect" href="async-sends.html" title="Async Sends">Async Sends</a> which adds a massive performance boost; but means that the send() method will return immediately whether the message has been sent or not which could lead to message loss. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> useCompression </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> Enables the use of compression of the message bodies </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> useRetroactiveConsumer </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> Sets whether or not retroactive consumers are enabled. Retroactive consumers allow non-durable topic subscribers to receive old messages that were published before the non-durable subscriber started. </td></tr><tr><td colspan="1" rowspan="1" class="conflue
nceTd"> warnAboutUnstartedConnectionTimeout </td><td colspan="1" rowspan="1" class="confluenceTd"> 500 </td><td colspan="1" rowspan="1" class="confluenceTd"> Enables the timeout in milliseconds from a connection creation to when a warning is generated if the connection is not properly started via <a shape="rect" class="external-link" href="http://java.sun.com/j2ee/1.4/docs/api/javax/jms/Connection.html#start()" rel="nofollow">Connection.start()</a> and a message is received by a consumer. It is a very common gotcha to forget to <a shape="rect" href="i-am-not-receiving-any-messages-what-is-wrong.html" title="I am not receiving any messages, what is wrong">start the connection and then wonder why no messages are delivered</a> so this option makes the default case to create a warning if the user forgets. To disable the warning just set the value to < 0 (say -1). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">auditDepth</td><td colspan="1" rowspan="1" class="
confluenceTd">2048</td><td colspan="1" rowspan="1" class="confluenceTd">The size of the message window that will be audited (for duplicates and out of order messages</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">auditMaximumProducerNumber</td><td colspan="1" rowspan="1" class="confluenceTd">64</td><td colspan="1" rowspan="1" class="confluenceTd">Maximum number of producers that will be audited</td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Option Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> alwaysSessionAsync </td><td colspan="1" rowspan="1" class="confluenceTd"> true </td><td colspan="1" rowspan="1" class="confluenceTd"> If this flag is set then a separate thread is used for dispatching messages for each Session in the Connection. However, a separate thread is always used if there is more than one session, or the session isn't in auto acknowledge or dups ok mode </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> clientID </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td><td colspan="1" rowspan="1" class="confluenceTd"> Sets the JMS clientID to use for the connection </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> close
Timeout </td><td colspan="1" rowspan="1" class="confluenceTd"> 15000ms </td><td colspan="1" rowspan="1" class="confluenceTd"> Sets the timeout before a close is considered complete. Normally a close() on a connection waits for confirmation from the broker; this allows that operation to timeout to save the client hanging if there is no broker. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> copyMessageOnSend </td><td colspan="1" rowspan="1" class="confluenceTd"> true </td><td colspan="1" rowspan="1" class="confluenceTd"> Should a JMS message be copied to a new JMS Message object as part of the send() method in JMS. This is enabled by default to be compliant with the JMS specification. You can disable it if you do not mutate JMS messages after they are sent for a performance boost. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> disableTimeStampsByDefault </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="
1" class="confluenceTd"> Sets whether or not timestamps on messages should be disabled or not. If you disable them it adds a small performance boost. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> dispatchAsync </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> Should the broker <a shape="rect" href="consumer-dispatch-async.html" title="Consumer Dispatch Async">dispatch messages asynchronously</a> to the consumer. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> nestedMapAndListEnabled </td><td colspan="1" rowspan="1" class="confluenceTd"> true </td><td colspan="1" rowspan="1" class="confluenceTd"> Enables/disables whether or not <a shape="rect" href="structured-message-properties-and-mapmessages.html" title="Structured Message Properties and MapMessages">Structured Message Properties and MapMessages</a> are supported so that Message properties and MapMessage entries can contain
nested Map and List objects. Available since version 4.1 onwards</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> objectMessageSerializationDefered </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> When an object is set on an ObjectMessage, the JMS spec requires the object to be serialized by that set method. Enabling this flag causes the object to not get serialized. The object may subsequently get serialized if the message needs to be sent over a socket or stored to disk. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> optimizeAcknowledge </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> Enables an optimised acknowledgement mode where messages are acknowledged in batches rather than individually. Alternatively, you could use Session.DUPS_OK_ACKNOWLEDGE acknowledgement mode for the consumers which can often be f
aster. <b>WARNING</b> enabling this issue could cause some issues with auto-acknowledgement on reconnection<br clear="none" class="atl-forced-newline"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> optimizeAcknowledgeTimeOut</td><td colspan="1" rowspan="1" class="confluenceTd">300ms</td><td colspan="1" rowspan="1" class="confluenceTd">if > 0, specifies the max time between batch acks when optimizeAcknowledge is enabled. (since 5.6)</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> optimizedMessageDispatch </td><td colspan="1" rowspan="1" class="confluenceTd"> true </td><td colspan="1" rowspan="1" class="confluenceTd"> If this flag is set then an larger prefetch limit is used - only applicable for durable topic subscribers <br clear="none" class="atl-forced-newline"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> useAsyncSend </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="
confluenceTd"> Forces the use of <a shape="rect" href="async-sends.html" title="Async Sends">Async Sends</a> which adds a massive performance boost; but means that the send() method will return immediately whether the message has been sent or not which could lead to message loss. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> useCompression </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> Enables the use of compression of the message bodies </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> useRetroactiveConsumer </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> Sets whether or not retroactive consumers are enabled. Retroactive consumers allow non-durable topic subscribers to receive old messages that were published before the non-durable subscriber started. </td></tr><tr><td colspan="1" rowspan="1" class="conflue
nceTd"> warnAboutUnstartedConnectionTimeout </td><td colspan="1" rowspan="1" class="confluenceTd"> 500 </td><td colspan="1" rowspan="1" class="confluenceTd"> Enables the timeout in milliseconds from a connection creation to when a warning is generated if the connection is not properly started via <a shape="rect" class="external-link" href="http://java.sun.com/j2ee/1.4/docs/api/javax/jms/Connection.html#start()" rel="nofollow">Connection.start()</a> and a message is received by a consumer. It is a very common gotcha to forget to <a shape="rect" href="i-am-not-receiving-any-messages-what-is-wrong.html" title="I am not receiving any messages, what is wrong">start the connection and then wonder why no messages are delivered</a> so this option makes the default case to create a warning if the user forgets. To disable the warning just set the value to < 0 (say -1). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">auditDepth</td><td colspan="1" rowspan="1" class="
confluenceTd">2048</td><td colspan="1" rowspan="1" class="confluenceTd">The size of the message window that will be audited (for duplicates and out of order messages</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">auditMaximumProducerNumber</td><td colspan="1" rowspan="1" class="confluenceTd">64</td><td colspan="1" rowspan="1" class="confluenceTd">Maximum number of producers that will be audited</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">alwaysSyncSend</td><td colspan="1" rowspan="1" class="confluenceTd">false</td><td colspan="1" rowspan="1" class="confluenceTd">When true a MessageProducer will always use Sync sends when sending a Message even if it is not required for the Delivery Mode</td></tr></tbody></table>
</div>