89 lines
		
	
	
		
			7.8 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
		
		
			
		
	
	
			89 lines
		
	
	
		
			7.8 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| 
								 | 
							
								<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat Configuration Reference - The Cluster Membership object</title><meta name="author" value="Filip Hanik"><meta name="email" value="fhanik@apache.org"></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><font face="arial,helvetica,sanserif"><h1>Apache Tomcat 6.0</h1></font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="../../images/asf-logo.gif" align="right" alt="Apache Logo" border="0"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><tr><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left"><table border="0" width="100%" cellspacing="4"><tr><td align="left" valign="top"><h1>Apache Tomcat Configuration Reference</h1><h2>The Cluster Membership object</h2></td><td align="right" valign="top" nowrap="true"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></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"><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"><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>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>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>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>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>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#tcpfailuredetector"><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>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>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>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>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></table>
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								  </blockquote></td></tr></table>
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>
							 | 
						||
| 
								 | 
							
								        Copyright © 1999-2006, Apache Software Foundation
							 | 
						||
| 
								 | 
							
								        </em></font></div></td></tr></table></body></html>
							 |