<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 Configuration Reference (7.0.77) - The Cluster Membership object</title><meta name="author" content="Filip Hanik"><style type="text/css" media="print"> | |
.noPrint {display: none;} | |
td#mainBody {width: 100%;} | |
</style><style type="text/css"> | |
code {background-color:rgb(224,255,255);padding:0 0.1em;} | |
code.attributeName, code.propertyName {background-color:transparent;} | |
table { | |
border-collapse: collapse; | |
text-align: left; | |
} | |
table *:not(table) { | |
/* Prevent border-collapsing for table child elements like <div> */ | |
border-collapse: separate; | |
} | |
th { | |
text-align: left; | |
} | |
div.codeBox pre code, code.attributeName, code.propertyName, code.noHighlight, .noHighlight code { | |
background-color: transparent; | |
} | |
div.codeBox { | |
overflow: auto; | |
margin: 1em 0; | |
} | |
div.codeBox pre { | |
margin: 0; | |
padding: 4px; | |
border: 1px solid #999; | |
border-radius: 5px; | |
background-color: #eff8ff; | |
display: table; /* To prevent <pre>s from taking the complete available width. */ | |
/* | |
When it is officially supported, use the following CSS instead of display: table | |
to prevent big <pre>s from exceeding the browser window: | |
max-width: available; | |
width: min-content; | |
*/ | |
} | |
div.codeBox pre.wrap { | |
white-space: pre-wrap; | |
} | |
table.defaultTable tr, table.detail-table tr { | |
border: 1px solid #CCC; | |
} | |
table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) { | |
background-color: #FAFBFF; | |
} | |
table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) { | |
background-color: #EEEFFF; | |
} | |
table.defaultTable th, table.detail-table th { | |
background-color: #88b; | |
color: #fff; | |
} | |
table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td { | |
padding: 5px 8px; | |
} | |
p.notice { | |
border: 1px solid rgb(255, 0, 0); | |
background-color: rgb(238, 238, 238); | |
color: rgb(0, 51, 102); | |
padding: 0.5em; | |
margin: 1em 2em 1em 1em; | |
} | |
</style></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img src="../images/tomcat.gif" align="right" alt=" | |
The Apache Tomcat Servlet/JSP Container | |
" border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 7</font></h1><font face="arial,helvetica,sanserif">Version 7.0.77, Mar 28 2017</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="../images/asf-logo.svg" align="right" alt="Apache Logo" border="0" style="width: 266px;height: 83px;"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap class="noPrint"><p><strong>Links</strong></p><ul><li><a href="../index.html">Docs Home</a></li><li><a href="index.html">Config Ref. Home</a></li><li><a href="http://wiki.apache.org/tomcat/FAQ">FAQ</a></li><li><a href="#comments_section">User Comments</a></li></ul><p><strong>Top Level Elements</strong></p><ul><li><a href="server.html">Server</a></li><li><a href="service.html">Service</a></li></ul><p><strong>Executors</strong></p><ul><li><a href="executor.html">Executor</a></li></ul><p><strong>Connectors</strong></p><ul><li><a href="http.html">HTTP</a></li><li><a href="ajp.html">AJP</a></li></ul><p><strong>Containers</strong></p><ul><li><a href="context.html">Context</a></li><li><a href="engine.html">Engine</a></li><li><a href="host.html">Host</a></li><li><a href="cluster.html">Cluster</a></li></ul><p><strong>Nested Components</strong></p><ul><li><a href="globalresources.html">Global Resources</a></li><li><a href="jar-scanner.html">JarScanner</a></li><li><a href="listeners.html">Listeners</a></li><li><a href="loader.html">Loader</a></li><li><a href="manager.html">Manager</a></li><li><a href="realm.html">Realm</a></li><li><a href="resources.html">Resources</a></li><li><a href="sessionidgenerator.html">SessionIdGenerator</a></li><li><a href="valve.html">Valve</a></li></ul><p><strong>Cluster Elements</strong></p><ul><li><a href="cluster.html">Cluster</a></li><li><a href="cluster-manager.html">Manager</a></li><li><a href="cluster-channel.html">Channel</a></li><li><a href="cluster-membership.html">Channel/Membership</a></li><li><a href="cluster-sender.html">Channel/Sender</a></li><li><a href="cluster-receiver.html">Channel/Receiver</a></li><li><a href="cluster-interceptor.html">Channel/Interceptor</a></li><li><a href="cluster-valve.html">Valve</a></li><li><a href="cluster-deployer.html">Deployer</a></li><li><a href="cluster-listener.html">ClusterListener</a></li></ul><p><strong>web.xml</strong></p><ul><li><a href="filter.html">Filter</a></li></ul><p><strong>Other</strong></p><ul><li><a href="systemprops.html">System properties</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>The Cluster Membership object</h1><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote> | |
<ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Default_Implementation">Default Implementation</a></li><li><a href="#Attributes">Attributes</a><ol><li><a href="#Multicast_Attributes">Multicast Attributes</a></li></ol></li></ul> | |
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> | |
<p> | |
The membership component in the Apache Tribes <a href="cluster-channel.html">Channel</a> is responsible | |
for dynamic discovery of other members(nodes) in the cluster. | |
</p> | |
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Default Implementation"><!--()--></a><a name="Default_Implementation"><strong>Default Implementation</strong></a></font></td></tr><tr><td><blockquote> | |
<p> | |
The default implementation of the cluster group notification is built on top of multicast heartbeats | |
sent using UDP packets to a multicast IP address. | |
Cluster members are grouped together by using the same multicast address/port combination. | |
Each member sends out a heartbeat with a given interval (<code>frequency</code>), and this | |
heartbeat is used for dynamic discovery. | |
In a similar fashion, if a heartbeat has not been received in a timeframe specified by <code>dropTime</code> | |
ms. a member is considered suspect and the channel and any membership listener will be notified. | |
</p> | |
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> | |
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Multicast Attributes"><!--()--></a><a name="Multicast_Attributes"><strong>Multicast Attributes</strong></a></font></td></tr><tr><td><blockquote> | |
<table border="1" cellpadding="5"><tr><th width="15%" bgcolor="#023264"><font color="#ffffff">Attribute</font></th><th width="85%" bgcolor="#023264"><font color="#ffffff">Description</font></th></tr><tr><td align="left" valign="center"><strong><code class="attributeName">className</code></strong></td><td align="left" valign="center"> | |
<p> | |
The default value is <code>org.apache.catalina.tribes.membership.McastService</code> | |
and is currently the only implementation. | |
This implementation uses multicast heartbeats for member discovery. | |
</p> | |
</td></tr><tr><td align="left" valign="center"><code class="attributeName">address</code></td><td align="left" valign="center"> | |
<p> | |
The multicast address that the membership will broadcast its presence and listen | |
for other heartbeats on. The default value is <code>228.0.0.4</code> | |
Make sure your network is enabled for multicast traffic.<br> | |
The multicast address, in conjunction with the <code>port</code> is what | |
creates a cluster group. To divide up your farm into several different group, or to | |
split up QA from production, change the <code>port</code> or the <code>address</code> | |
<br>Previously known as mcastAddr. | |
</p> | |
</td></tr><tr><td align="left" valign="center"><code class="attributeName">port</code></td><td align="left" valign="center"> | |
<p> | |
The multicast port, the default value is <code>45564</code><br> | |
The multicast port, in conjunction with the <code>address</code> is what | |
creates a cluster group. To divide up your farm into several different group, or to | |
split up QA from production, change the <code>port</code> or the <code>address</code> | |
</p> | |
</td></tr><tr><td align="left" valign="center"><code class="attributeName">frequency</code></td><td align="left" valign="center"> | |
<p> | |
The frequency in milliseconds in which heartbeats are sent out. The default value is <code>500</code> ms.<br> | |
In most cases the default value is sufficient. Changing this value, simply changes the interval in between heartbeats. | |
</p> | |
</td></tr><tr><td align="left" valign="center"><code class="attributeName">dropTime</code></td><td align="left" valign="center"> | |
<p> | |
The membership component will time out members and notify the Channel if a member fails to send a heartbeat within | |
a give time. The default value is <code>3000</code> ms. This means, that if a heartbeat is not received from a | |
member in that timeframe, the membership component will notify the cluster of this.<br> | |
On a high latency network you may wish to increase this value, to protect against false positives.<br> | |
Apache Tribes also provides a <a href="cluster-interceptor.html#org.apache.catalina.tribes.group.interceptors.TcpFailureDetector_Attributes"><code>TcpFailureDetector</code></a> that will | |
verify a timeout using a TCP connection when a heartbeat timeout has occurred. This protects against false positives. | |
</p> | |
</td></tr><tr><td align="left" valign="center"><code class="attributeName">bind</code></td><td align="left" valign="center"> | |
<p> | |
Use this attribute if you wish to bind your multicast traffic to a specific network interface. | |
By default, or when this attribute is unset, it tries to bind to <code>0.0.0.0</code> and sometimes on multihomed hosts | |
this becomes a problem. | |
</p> | |
</td></tr><tr><td align="left" valign="center"><code class="attributeName">ttl</code></td><td align="left" valign="center"> | |
<p> | |
The time-to-live setting for the multicast heartbeats. | |
This setting should be a value between 0 and 255. The default value is VM implementation specific. | |
</p> | |
</td></tr><tr><td align="left" valign="center"><code class="attributeName">domain</code></td><td align="left" valign="center"> | |
<p> | |
Apache Tribes has the ability to logically group members into domains, by using this domain attribute. | |
The <code>org.apache.catalina.tribes.Member.getDomain()</code> method returns the value specified here. | |
</p> | |
</td></tr><tr><td align="left" valign="center"><code class="attributeName">soTimeout</code></td><td align="left" valign="center"> | |
<p> | |
The sending and receiving of heartbeats is done on a single thread, hence to avoid blocking this thread forever, | |
you can control the <code>SO_TIMEOUT</code> value on this socket.<br> | |
If a value smaller or equal to 0 is presented, the code will default this value to frequency | |
</p> | |
</td></tr><tr><td align="left" valign="center"><code class="attributeName">recoveryEnabled</code></td><td align="left" valign="center"> | |
<p> | |
In case of a network failure, Java multicast socket don't transparently fail over, instead the socket will continuously | |
throw IOException upon each receive request. When recoveryEnabled is set to true, this will close the multicast socket | |
and open a new socket with the same properties as defined above.<br> | |
The default is <code>true</code>. <br> | |
</p> | |
</td></tr><tr><td align="left" valign="center"><code class="attributeName">recoveryCounter</code></td><td align="left" valign="center"> | |
<p> | |
When <code>recoveryEnabled==true</code> this value indicates how many | |
times an error has to occur before recovery is attempted. The default is | |
<code>10</code>. <br> | |
</p> | |
</td></tr><tr><td align="left" valign="center"><code class="attributeName">recoverySleepTime</code></td><td align="left" valign="center"> | |
<p> | |
When <code>recoveryEnabled==true</code> this value indicates how long time (in milliseconds) | |
the system will sleep in between recovery attempts, until it recovers successfully. | |
The default is <code>5000</code> (5 seconds). <br> | |
</p> | |
</td></tr><tr><td align="left" valign="center"><code class="attributeName">localLoopbackDisabled</code></td><td align="left" valign="center"> | |
<p> | |
Membership uses multicast, it will call <code>java.net.MulticastSocket.setLoopbackMode(localLoopbackDisabled)</code>. | |
When <code>localLoopbackDisabled==true</code> multicast messages will not reach other nodes on the same local machine. | |
The default is <code>false</code>. <br> | |
</p> | |
</td></tr></table> | |
</blockquote></td></tr></table> | |
</blockquote></td></tr></table></td></tr><tr class="noPrint"><td width="20%" valign="top" nowrap class="noPrint"></td><td width="80%" valign="top" align="left"><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="comments_section" id="comments_section"><strong>Comments</strong></a></font></td></tr><tr><td><blockquote><p class="notice"><strong>Notice: </strong>This comments section collects your suggestions | |
on improving documentation for Apache Tomcat.<br><br> | |
If you have trouble and need help, read | |
<a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page | |
and ask your question on the tomcat-users | |
<a href="http://tomcat.apache.org/lists.html">mailing list</a>. | |
Do not ask such questions here. This is not a Q&A section.<br><br> | |
The Apache Comments System is explained <a href="../comments.html">here</a>. | |
Comments may be removed by our moderators if they are either | |
implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!-- | |
var comments_shortname = 'tomcat'; | |
var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/config/cluster-membership.html'; | |
(function(w, d) { | |
if (w.location.hostname.toLowerCase() == "tomcat.apache.org") { | |
d.write('<div id="comments_thread"><\/div>'); | |
var s = d.createElement('script'); | |
s.type = 'text/javascript'; | |
s.async = true; | |
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; | |
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); | |
} | |
else { | |
d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>'); | |
} | |
})(window, document); | |
//--><!]]></script></blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em> | |
Copyright © 1999-2017, Apache Software Foundation | |
</em></font></div></td></tr></table></body></html> |