| 1 | <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 value="Filip Hanik" name="author"><meta value="fhanik@apache.org" name="email"></head><body vlink="#525D76" alink="#525D76" link="#525D76" text="#000000" bgcolor="#ffffff"><table cellspacing="0" width="100%" border="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img border="0" alt=" |
|---|
| 2 | The Apache Tomcat Servlet/JSP Container |
|---|
| 3 | " align="right" src="../images/tomcat.gif"></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 border="0" alt="Apache Logo" align="right" src="../images/asf-logo.gif"></a></td></tr></table><table cellspacing="4" width="100%" border="0"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><tr><!--LEFT SIDE NAVIGATION--><td nowrap="true" valign="top" width="20%"><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></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="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="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>Global Settings</strong></p><ul><li><a href="systemprops.html">System properties</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td align="left" valign="top" width="80%"><table cellspacing="4" width="100%" border="0"><tr><td valign="top" align="left"><h1>Apache Tomcat Configuration Reference</h1><h2>The Cluster Membership object</h2></td><td nowrap="true" valign="top" align="right"><small><a href="printer/cluster-membership.html"><img alt="Printer Friendly Version" border="0" src="../images/printer.gif"><br>print-friendly<br>version |
|---|
| 4 | </a></small></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 5 | <p> |
|---|
| 6 | The membership component in the Apache Tribes <a href="cluster-channel.html">Channel</a> is responsible |
|---|
| 7 | for dynamic discovery of other members(nodes) in the cluster. |
|---|
| 8 | </p> |
|---|
| 9 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Default Implementation"><strong>Default Implementation</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 10 | <p> |
|---|
| 11 | The default implementation of the cluster group notification is built on top of multicast heartbeats |
|---|
| 12 | sent using UDP packets to a multicast IP address. |
|---|
| 13 | Cluster members are grouped together by using the same multicast address/port combination. |
|---|
| 14 | Each member sends out a heartbeat with a given interval (<code>frequency</code>), and this |
|---|
| 15 | heartbeat is used for dynamic discovery. |
|---|
| 16 | In a similar fashion, if a heartbeat has not been received in a timeframe specified by <code>dropTime</code> |
|---|
| 17 | ms. a member is considered suspect and the channel and any membership listener will be notified. |
|---|
| 18 | </p> |
|---|
| 19 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 20 | |
|---|
| 21 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Multicast Attributes"><strong>Multicast Attributes</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 22 | |
|---|
| 23 | <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><strong><code>className</code></strong></td><td valign="center" align="left"> |
|---|
| 24 | <p> |
|---|
| 25 | The default value is <code>org.apache.catalina.tribes.membership.McastService</code> |
|---|
| 26 | and is currently the only implementation. |
|---|
| 27 | This implementation uses multicast heartbeats for member discovery. |
|---|
| 28 | </p> |
|---|
| 29 | </td></tr><tr><td valign="center" align="left"><code>address</code></td><td valign="center" align="left"> |
|---|
| 30 | <p> |
|---|
| 31 | The multicast address that the membership will broadcast its presence and listen |
|---|
| 32 | for other heartbeats on. The default value is <code>228.0.0.4</code> |
|---|
| 33 | Make sure your network is enabled for multicast traffic.<br> |
|---|
| 34 | The multicast address, in conjunction with the <code>port</code> is what |
|---|
| 35 | creates a cluster group. To divide up your farm into several different group, or to |
|---|
| 36 | split up QA from production, change the <code>port</code> or the <code>address</code> |
|---|
| 37 | <br>Previously known as mcastAddr. |
|---|
| 38 | </p> |
|---|
| 39 | </td></tr><tr><td valign="center" align="left"><code>port</code></td><td valign="center" align="left"> |
|---|
| 40 | <p> |
|---|
| 41 | The multicast port, the default value is <code>45564</code><br> |
|---|
| 42 | The multicast port, in conjunction with the <code>address</code> is what |
|---|
| 43 | creates a cluster group. To divide up your farm into several different group, or to |
|---|
| 44 | split up QA from production, change the <code>port</code> or the <code>address</code> |
|---|
| 45 | </p> |
|---|
| 46 | </td></tr><tr><td valign="center" align="left"><code>frequency</code></td><td valign="center" align="left"> |
|---|
| 47 | <p> |
|---|
| 48 | The frequency in milliseconds in which heartbeats are sent out. The default value is <code>500</code> ms.<br> |
|---|
| 49 | In most cases the default value is sufficient. Changing this value, simply changes the interval in between heartbeats. |
|---|
| 50 | </p> |
|---|
| 51 | </td></tr><tr><td valign="center" align="left"><code>dropTime</code></td><td valign="center" align="left"> |
|---|
| 52 | <p> |
|---|
| 53 | The membership component will time out members and notify the Channel if a member fails to send a heartbeat within |
|---|
| 54 | a give time. The default value is <code>3000</code> ms. This means, that if a heartbeat is not received from a |
|---|
| 55 | member in that timeframe, the membership component will notify the cluster of this.<br> |
|---|
| 56 | On a high latency network you may wish to increase this value, to protect against false positives.<br> |
|---|
| 57 | Apache Tribes also provides a <a href="cluster-interceptor.html#tcpfailuredetector"><code>TcpFailureDetector</code></a> that will |
|---|
| 58 | verify a timeout using a TCP connection when a heartbeat timeout has occurred. This protects against false positives. |
|---|
| 59 | </p> |
|---|
| 60 | </td></tr><tr><td valign="center" align="left"><code>bind</code></td><td valign="center" align="left"> |
|---|
| 61 | <p> |
|---|
| 62 | Use this attribute if you wish to bind your multicast traffic to a specific network interface. |
|---|
| 63 | By default, or when this attribute is unset, it tries to bind to <code>0.0.0.0</code> and sometimes on multihomed hosts |
|---|
| 64 | this becomes a problem. |
|---|
| 65 | </p> |
|---|
| 66 | </td></tr><tr><td valign="center" align="left"><code>ttl</code></td><td valign="center" align="left"> |
|---|
| 67 | <p> |
|---|
| 68 | The time-to-live setting for the multicast heartbeats. |
|---|
| 69 | This setting should be a value between 0 and 255. The default value is VM implementation specific. |
|---|
| 70 | </p> |
|---|
| 71 | </td></tr><tr><td valign="center" align="left"><code>domain</code></td><td valign="center" align="left"> |
|---|
| 72 | <p> |
|---|
| 73 | Apache Tribes has the ability to logically group members into domains, by using this domain attribute. |
|---|
| 74 | The <code>org.apache.catalina.tribes.Member.getDomain()</code> method returns the value specified here. |
|---|
| 75 | </p> |
|---|
| 76 | </td></tr><tr><td valign="center" align="left"><code>soTimeout</code></td><td valign="center" align="left"> |
|---|
| 77 | <p> |
|---|
| 78 | The sending and receiving of heartbeats is done on a single thread, hence to avoid blocking this thread forever, |
|---|
| 79 | you can control the <code>SO_TIMEOUT</code> value on this socket.<br> |
|---|
| 80 | If a value smaller or equal to 0 is presented, the code will default this value to frequency |
|---|
| 81 | </p> |
|---|
| 82 | </td></tr></table> |
|---|
| 83 | |
|---|
| 84 | |
|---|
| 85 | </blockquote></td></tr></table> |
|---|
| 86 | |
|---|
| 87 | |
|---|
| 88 | </blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font size="-1" color="#525D76"><em> |
|---|
| 89 | Copyright © 1999-2008, Apache Software Foundation |
|---|
| 90 | </em></font></div></td></tr></table></body></html> |
|---|
