Author: buildbot
Date: Fri Dec 18 20:21:56 2015
New Revision: 975897
Log:
Production update by buildbot for activemq
Modified:
websites/production/activemq/content/cache/main.pageCache
websites/production/activemq/content/failover-transport-reference.html
Modified: websites/production/activemq/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/activemq/content/failover-transport-reference.html
==============================================================================
--- websites/production/activemq/content/failover-transport-reference.html
(original)
+++ websites/production/activemq/content/failover-transport-reference.html Fri
Dec 18 20:21:56 2015
@@ -84,7 +84,7 @@
<div class="wiki-content maincontent"><h3
id="FailoverTransportReference-TheFailoverTransport">The Failover
Transport</h3><p>The Failover transport layers reconnect logic on top of any of
the other transports. The configuration syntax allows you to specify any number
of composite URIs. The Failover transport randomly chooses one of the composite
URIs and attempts to establish a connection to it. If it does not succeed, or
if it subsequently fails, a new connection is established choosing one of the
other URIs randomly from the list.</p><h4
id="FailoverTransportReference-ConfigurationSyntax">Configuration
Syntax</h4><p><code><strong>failover:(uri1,...,uriN)?transportOptions&nestedURIOptions</strong></code></p><p>or</p><p><code><strong>failover:uri1,...,uriN</strong></code></p><h5
id="FailoverTransportReference-UsingRandomize">Using Randomize</h5><p>The
Failover transport chooses a URI at <code>random</code> by default. This
effectively load-balances clients over multiple brokers.
However, to have a client connect to a primary first and only connect to a
secondary backup broker when the primary is unavailable, set
<strong><code>randomize=false</code></strong>. For
example:</p><p> </p><div class="preformatted panel" style="border-width:
1px;"><div class="preformattedContent panelContent">
<pre>failover:(tcp://primary:61616,tcp://secondary:61616)?randomize=false
</pre>
-</div></div><h5 id="FailoverTransportReference-TransportOptions">Transport
Options</h5><p> </p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Option Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>initialReconnectDelay</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>10</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The delay (in ms) before the
<em>first</em> reconnect attempt.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maxReconnectDelay</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>30000</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The maximum delay (in ms) between the
<em>second and subsequent</em> reconnect
attempts.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>useExponentialBackOff</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>If
<strong><code>true</code></strong> an exponential back-off is used between
reconnect attempts.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>reconnectDelayExponent</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>2.0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The exponent used during
exponential back-off attempts.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maxReconnectAttempts</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>-1 | 0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><em>From</em> ActiveMQ 5.6:
default is <strong><code>-1</code></strong>, retry forever. <strong><code>0</c
ode></strong> means disables re-connection, e.g: just try to connect once.<br
clear="none" class="atl-forced-newline"> <em>Before</em> ActiveMQ 5.6: default
is <strong><code>0</code></strong>, retry forever. <br clear="none"
class="atl-forced-newline"> <em>All versions</em>: a value
<strong><code>>0</code></strong> denotes the maximum number of reconnect
attempts before an error is sent back to the client.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>startupMaxReconnectAttempts</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>A value of
<strong><code>-1</code></strong> denotes that the number of connection attempts
at startup should be unlimited.</p><p>A value of  <strong><code>>=0
</code></strong>denotes the number of reconnect attempts at startup that will
be made after which an error is sent back to the client when the client makes a
subsequent re
connect attempt.</p><p><strong>Note</strong>: once successfully connected the
<code><strong>maxReconnectAttempts</strong></code> option take precedence over
this option.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>randomize</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>If <strong><code>true</code></strong>,
choose a URI at random from the list to use for reconnect.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>backup</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Initialize and hold a second
transport connection - to enable fast failover.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>timeout</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td colspan="1" rows
pan="1" class="confluenceTd"><p>Set the timeout on send operations (in ms)
without interruption of re-connection process. <strong>Since ActiveMQ
5.3</strong>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>trackMessages</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Keep a cache of in-flight messages that
will flushed to a broker on reconnect.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>maxCacheSize</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>131072</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Size in bytes for the cache of
tracked messages. Applicable only if
<strong><code>trackMessages</code></strong> is
<strong><code>true</code></strong>.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>updateURIsSupported</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Determines whether the client should accept updates
from the broker to its list of known URIs. <strong>Since</strong><strong>
ActiveMQ 5.4.</strong></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>updateURIsURL</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>A URL (or path to a local file) to a text
file containing a comma separated list of URIs to use for reconnect in the case
of failure. <strong>Since ActiveMQ 5.4.</strong></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>nested.*</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Extra options to add to the nested URLs.
<strong>Since ActiveMQ 5.9.</strong></p></td></tr><tr><td colspan=
"1" rowspan="1"
class="confluenceTd"><p><code>warnAfterReconnectAttempts</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>10</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>A value
<strong><code>>0</code></strong> specifies the number of reconnect attempts
before a warning is logged. A logged warning indicates that there is no current
connection but re-connection is being attempted.</p><p>A value of
<strong><code><=0</code></strong> disables the logging of warnings about
reconnect attempts. <strong>Since ActiveMQ 5.10.</strong></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>reconnectSupported</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Determines whether the client should
respond to broker <strong><code>ConnectionControl</code></strong> events with a
reconnect (see: <strong><code>rebalanceClusterClients</cod
e>).</strong></p></td></tr></tbody></table></div><h5
id="FailoverTransportReference-ExampleURI">Example URI</h5><p> </p><div
class="preformatted panel" style="border-width: 1px;"><div
class="preformattedContent panelContent">
+</div></div><h5 id="FailoverTransportReference-TransportOptions">Transport
Options</h5><p> </p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Option Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>initialReconnectDelay</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>10</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The delay (in ms) before the
<em>first</em> reconnect attempt.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maxReconnectDelay</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>30000</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The maximum delay (in ms) between the
<em>second and subsequent</em> reconnect
attempts.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>useExponentialBackOff</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>If
<strong><code>true</code></strong> an exponential back-off is used between
reconnect attempts.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>reconnectDelayExponent</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>2.0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The exponent used during
exponential back-off attempts.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maxReconnectAttempts</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>-1 | 0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><em>From</em> ActiveMQ 5.6:
default is <strong><code>-1</code></strong>, retry forever. <strong><code>0</c
ode></strong> means disables re-connection, e.g: just try to connect once.<br
clear="none" class="atl-forced-newline"> <em>Before</em> ActiveMQ 5.6: default
is <strong><code>0</code></strong>, retry forever. <br clear="none"
class="atl-forced-newline"> <em>All versions</em>: a value
<strong><code>>0</code></strong> denotes the maximum number of reconnect
attempts before an error is sent back to the client.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>startupMaxReconnectAttempts</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>A value of
<strong><code>-1</code></strong> denotes that the number of connection attempts
at startup should be unlimited.</p><p>A value of  <strong><code>>=0
</code></strong>denotes the number of reconnect attempts at startup that will
be made after which an error is sent back to the client when the client makes a
subsequent re
connect attempt.</p><p><strong>Note</strong>: once successfully connected the
<code><strong>maxReconnectAttempts</strong></code> option
prevails.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>randomize</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>If <strong><code>true</code></strong>,
choose a URI at random from the list to use for reconnect.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>backup</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Initialize and hold a second
transport connection - to enable fast failover.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>timeout</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td colspan="1"
rowspan="1" class="confluenc
eTd"><p>Set the timeout on send operations (in ms) without interruption of
re-connection process. <strong>Since ActiveMQ
5.3</strong>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>trackMessages</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Keep a cache of in-flight messages that
will flushed to a broker on reconnect.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>maxCacheSize</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>131072</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Size in bytes for the cache of
tracked messages. Applicable only if
<strong><code>trackMessages</code></strong> is
<strong><code>true</code></strong>.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>updateURIsSupported</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>
<code>true</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Determines whether the client should accept updates
from the broker to its list of known URIs. <strong>Since</strong><strong>
ActiveMQ 5.4.</strong></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>updateURIsURL</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>A URL (or path to a local file) to a text
file containing a comma separated list of URIs to use for reconnect in the case
of failure. <strong>Since ActiveMQ 5.4.</strong></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>nested.*</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Common URI options that will be applied to
each URI in the list. <strong>Since ActiveMQ 5.9.</strong></p></td></tr><tr><td
colspan=
"1" rowspan="1"
class="confluenceTd"><p><code>warnAfterReconnectAttempts</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>10</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>A value
<strong><code>>0</code></strong> specifies the number of reconnect attempts
before a warning is logged. A logged warning indicates that there is no current
connection but re-connection is being attempted.</p><p>A value of
<strong><code><=0</code></strong> disables the logging of warnings about
reconnect attempts. <strong>Since ActiveMQ 5.10.</strong></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>reconnectSupported</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Determines whether the client should
respond to broker <strong><code>ConnectionControl</code></strong> events with a
reconnect (see: <strong><code>rebalanceClusterClients</cod
e>).</strong></p></td></tr></tbody></table></div><h5
id="FailoverTransportReference-ExampleURI">Example URI</h5><p> </p><div
class="preformatted panel" style="border-width: 1px;"><div
class="preformattedContent panelContent">
<pre>failover:(tcp://localhost:61616,tcp://remotehost:61616)?initialReconnectDelay=100
</pre>
</div></div><h5 id="FailoverTransportReference-Notes">Notes</h5><p>Under the
Failover transport send operations will, by default, block indefinitely when
the broker becomes unavailable. There are two options available for handling
this scenario. First, either set a <a shape="rect" class="external-link"
href="http://activemq.apache.org/maven/5.5.0/activemq-core/apidocs/org/apache/activemq/transport/TransportListener.html";>TransportListener</a>
directly on the <a shape="rect" class="external-link"
href="http://activemq.apache.org/maven/5.5.0/activemq-core/apidocs/org/apache/activemq/ActiveMQConnectionFactory.html#setTransportListener(org.apache.activemq.transport.TransportListener)">ActiveMQConnectionFactory</a>,
so that it is in place before any request that may require a network hop or
second, set the <strong><code>timeout</code></strong> option. The
<strong><code>timeout</code></strong> option causes the current send operation
to fail after the specified timeout. For example:</p><p
> </p><div class="preformatted panel" style="border-width: 1px;"><div
>class="preformattedContent panelContent">
