Added: tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster-sender.html
URL:
http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster-sender.html?rev=1417624&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster-sender.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster-sender.html Wed Dec 5
20:20:35 2012
@@ -0,0 +1,157 @@
+<html><head><META http-equiv="Content-Type" content="text/html;
charset=iso-8859-1"><title>Apache Tomcat 8 Configuration Reference (8.0.0-dev)
- The Cluster Sender 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;}
+ </style><style type="text/css">
+ .wrapped-source code { display: block; background-color:
transparent; }
+ .wrapped-source div { margin: 0 0 0 1.25em; }
+ .wrapped-source p { margin: 0 0 0 1.25em; text-indent: -1.25em; }
+ </style><style type="text/css">
+ 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 8</font></h1><font face="arial,helvetica,sanserif">Version 8.0.0-dev,
Dec 5 2012</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 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">Executo
r</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="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/M
embership</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>Other</strong></p><ul><li><a
href="filter.html">Filter</a></li><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 Sender
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="#Concurrent_Parallel_Delivery">Concurrent Parallel
Delivery</a></li><li><a href="#Nested_Elements">Nested Elements</a></li><li><a
href="#Attributes">Attributes</a><ol><li><a
href="#Common_Sender_Attributes">Common Sender Attributes</a></li><li><a
href="#Common_Transport_Attributes">Common Transport Attributes</a></li><li><a
href="#PooledParallelSender_Attributes">PooledParallelSender
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 channel sender component is responsible for delivering outgoing cluster
messages over the network.
+ In the default implementation,
<code>org.apache.catalina.tribes.transport.ReplicationTransmitter</code>,
+ the sender is a fairly empty shell with not much logic around a fairly
complex <code><Transport></code>
+ component the implements the actual delivery mechanism.
+ </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="Concurrent Parallel
Delivery"><!--()--></a><a
name="Concurrent_Parallel_Delivery"><strong>Concurrent Parallel
Delivery</strong></a></font></td></tr><tr><td><blockquote>
+ <p>
+ In the default <code>transport</code> implementation,
<code>org.apache.catalina.tribes.transport.nio.PooledParallelSender</code>,
+ Apache Tribes implements what we like to call "Concurrent Parallel Delivery".
+ This means that we can send a message to more than one destination at the
same time(parallel), and
+ deliver two messages to the same destination at the same time(concurrent).
Combine these two and we have
+ "Concurrent Parallel Delivery".
+ </p>
+ <p>
+ When is this useful? The simplest example we can think of is when part of
your code is sending a 10MB message,
+ like a war file being deployed, and you need to push through a small 10KB
message, say a session being replicated,
+ you don't have to wait for the 10MB message to finish, as a separate thread
will push in the small message
+ transmission at the same time. Currently there is no interrupt, pause or
priority mechanism available, but check back soon.
+ </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="Nested Elements"><!--()--></a><a
name="Nested_Elements"><strong>Nested
Elements</strong></a></font></td></tr><tr><td><blockquote>
+ <p>
+ The nested element <code><Transport></code> is is not required, by
encouraged, as this is where
+ you would set all the socket options for the outgoing messages. Please see
its attributes below.
+ There are two implementations, in a similar manner to the <a
href="cluster-receiver.html">receiver</a>, one is non-blocking
+ based and the other is built using blocking IO. <br>
+ <code>org.apache.catalina.tribes.transport.bio.PooledMultiSender</code> is
the blocking implementation and
+ <code>org.apache.catalina.tribes.transport.nio.PooledParallelSender</code>.
+ Parallel delivery is not available for the blocking implementation due to
the fact that it is blocking a thread on sending data.
+ </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="Common Sender Attributes"><!--()--></a><a
name="Common_Sender_Attributes"><strong>Common Sender
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">
+ Required, only available implementation is
<code>org.apache.catalina.tribes.transport.ReplicationTransmitter</code>
+ </td></tr></table>
+ </blockquote></td></tr></table>
+ <table border="0" cellspacing="0" cellpadding="2"><tr><td
bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a
name="Common Transport Attributes"><!--()--></a><a
name="Common_Transport_Attributes"><strong>Common Transport
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">
+ Required, an implementation of the
<code>org.apache.catalina.tribes.transport.MultiPointSender</code>.<br>
+ Non-blocking implementation is
<code>org.apache.catalina.tribes.transport.nio.PooledParallelSender</code><br>
+ Blocking implementation is
<code>org.apache.catalina.tribes.transport.bio.PooledMultiSender</code>
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">rxBufSize</code></td><td align="left" valign="center">
+ The receive buffer size on the socket.
+ Default value is <code>25188</code> bytes.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">txBufSize</code></td><td align="left" valign="center">
+ The send buffer size on the socket.
+ Default value is <code>43800</code> bytes.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">udpRxBufSize</code></td><td align="left" valign="center">
+ The receive buffer size on the datagram socket.
+ Default value is <code>25188</code> bytes.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">udpTxBufSize</code></td><td align="left" valign="center">
+ The send buffer size on the datagram socket.
+ Default value is <code>43800</code> bytes.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">directBuffer</code></td><td align="left" valign="center">
+ Possible values are <code>true</code> or <code>false</code>.
+ Set to true if you want the receiver to use direct bytebuffers when
writing data
+ to the sockets. Default value is <code>false</code>
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">keepAliveCount</code></td><td align="left"
valign="center">
+ The number of requests that can go through the socket before the socket
is closed, and reopened
+ for the next request. The default value is <code>-1</code>, which is
unlimited.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">keepAliveTime</code></td><td align="left" valign="center">
+ The number of milliseconds a connection is kept open after its been
opened.
+ The default value is <code>-1</code>, which is unlimited.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">timeout</code></td><td align="left" valign="center">
+ Sets the SO_TIMEOUT option on the socket. The value is in milliseconds
and the default value is <code>3000</code>
+ milliseconds.(3 seconds) This timeout starts when a message send
attempt is starting, until the transfer has been completed.
+ For the NIO sockets, this will mean, that the caller can guarantee
that we will not attempt sending the message
+ longer than this timeout value. For the blocking IO implementation,
this translated directly to the soTimeout.<br>
+ A timeout will not spawn a retry attempt, in order to guarantee the
return of the application thread.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">maxRetryAttempts</code></td><td align="left"
valign="center">
+ How many times do we retry a failed message, that received a
IOException at the socket level.
+ The default value is <code>1</code>, meaning we will retry a message
that has failed once.
+ In other words, we will attempt a message send no more than twice. One
is the original send, and one is the
+ <code>maxRetryAttempts</code>.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">ooBInline</code></td><td align="left" valign="center">
+ Boolean value for the socket OOBINLINE option. Possible values are
<code>true</code> or <code>false</code>.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">soKeepAlive</code></td><td align="left" valign="center">
+ Boolean value for the socket SO_KEEPALIVE option. Possible values are
<code>true</code> or <code>false</code>.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">soLingerOn</code></td><td align="left" valign="center">
+ Boolean value to determine whether to use the SO_LINGER socket option.
+ Possible values are <code>true</code> or <code>false</code>. Default
value is <code>true</code>.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">soLingerTime</code></td><td align="left" valign="center">
+ Sets the SO_LINGER socket option time value. The value is in seconds.
+ The default value is <code>3</code> seconds.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">soReuseAddress</code></td><td align="left"
valign="center">
+ Boolean value for the socket SO_REUSEADDR option. Possible values are
<code>true</code> or <code>false</code>.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">soTrafficClass</code></td><td align="left"
valign="center">
+ Sets the traffic class level for the socket, the value is between 0 and
255.
+ Default value is <code>int soTrafficClass = 0x04 | 0x08 | 0x010;</code>
+ Different values are defined in <a
href="http://docs.oracle.com/javase/6/docs/api/java/net/Socket.html#setTrafficClass(int)">
+ java.net.Socket#setTrafficClass(int)</a>.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">tcpNoDelay</code></td><td align="left" valign="center">
+ Boolean value for the socket TCP_NODELAY option. Possible values are
<code>true</code> or <code>false</code>.
+ The default value is <code>true</code>
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">throwOnFailedAck</code></td><td align="left"
valign="center">
+ Boolean value, default value is <code>true</code>.
+ If set to true, the sender will throw a
<code>org.apache.catalina.tribes.RemoteProcessException</code>
+ when we receive a negative ack from the remote member.
+ Set to false, and Tribes will treat a positive ack the same way as a
negative ack, that the message was received.
+ </td></tr></table>
+ </blockquote></td></tr></table>
+ <table border="0" cellspacing="0" cellpadding="2"><tr><td
bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a
name="PooledParallelSender Attributes"><!--()--></a><a
name="PooledParallelSender_Attributes"><strong>PooledParallelSender
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"><code
class="attributeName">poolSize</code></td><td align="left" valign="center">
+ The maximum number of concurrent connections from A to B.
+ The value is based on a per-destination count.
+ The default value is <code>25</code>
+ </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 is not a Q&A section.
+ The Apache Comments System is explained
+ <a href="/tomcat-8.0-doc/comments.html">here</a>.
+ Comments should be pointed towards suggestions on improving the
documentation
+ or server, and may be removed again by our moderators if they
are either
+ implemented or considered invalid/off-topic.
+ Questions on how to manage Apache Tomcat should be directed
+ to our <a href="http://tomcat.apache.org/lists.html";>mailing
lists</a>.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
+ var comments_shortname = 'tomcat';
+ var comments_identifier =
'http://tomcat.apache.org/tomcat-8.0-doc/config/cluster-sender.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-2012, Apache Software Foundation
+ </em></font></div></td></tr></table></body></html>
\ No newline at end of file
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster-sender.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster-sender.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster-valve.html
URL:
http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster-valve.html?rev=1417624&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster-valve.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster-valve.html Wed Dec 5
20:20:35 2012
@@ -0,0 +1,100 @@
+<html><head><META http-equiv="Content-Type" content="text/html;
charset=iso-8859-1"><title>Apache Tomcat 8 Configuration Reference (8.0.0-dev)
- The Cluster Valve 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;}
+ </style><style type="text/css">
+ .wrapped-source code { display: block; background-color:
transparent; }
+ .wrapped-source div { margin: 0 0 0 1.25em; }
+ .wrapped-source p { margin: 0 0 0 1.25em; text-indent: -1.25em; }
+ </style><style type="text/css">
+ 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 8</font></h1><font face="arial,helvetica,sanserif">Version 8.0.0-dev,
Dec 5 2012</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 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">Executo
r</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="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/M
embership</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>Other</strong></p><ul><li><a
href="filter.html">Filter</a></li><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 Valve 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="#org.apache.catalina.ha.tcp.ReplicationValve">org.apache.catalina.ha.tcp.ReplicationValve</a><ol><li><a
href="#org.apache.catalina.ha.tcp.ReplicationValve/Attributes">Attributes</a></li></ol></li><li><a
href="#org.apache.catalina.ha.session.JvmRouteBinderValve">org.apache.catalina.ha.session.JvmRouteBinderValve</a><ol><li><a
href="#org.apache.catalina.ha.session.JvmRouteBinderValve/Attributes">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>
+ A cluster valve is no different from any other <a href="valve.html">Tomcat
<code>Valve</code></a>.
+ The cluster valves are interceptors in the invocation chain for HTTP
requests, and the clustering implementation
+ uses these valves to make intelligent decision around data and when data
should be replicated.
+ </p>
+ <p>
+ A cluster valve must implement the
<code>org.apache.catalina.ha.ClusterValve</code> interface.
+ This is a simple interface that extends the
<code>org.apache.catalina.Valve</code> interface.
+ </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="org.apache.catalina.ha.tcp.ReplicationValve"><strong>org.apache.catalina.ha.tcp.ReplicationValve</strong></a></font></td></tr><tr><td><blockquote>
+ The <code>ReplicationValve</code> will notify the cluster at the end of a
HTTP request
+ so that the cluster can make a decision whether there is data to be
replicated or not.
+ <table border="0" cellspacing="0" cellpadding="2"><tr><td
bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a
name="org.apache.catalina.ha.tcp.ReplicationValve/Attributes"><strong>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">
+ Set value to <code>org.apache.catalina.ha.tcp.ReplicationValve</code>
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">filter</code></td><td align="left" valign="center">
+ For known file extensions or urls, you can use this Valve to notify the
+ cluster that the session has not been modified during this request and
+ the cluster doesn't have to probe the session managers for changes. If
+ the request matches this filter pattern, the cluster assumes there has
+ been no session change. An example filter would look like <code>
+
filter=".*\.gif|.*\.js|.*\.jpeg|.*\.jpg|.*\.png|.*\.htm|.*\.html|.*\.css|.*\.txt"
+ </code>. The filter is a regular expression using
+ <code>java.util.regex</code>.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">primaryIndicator</code></td><td align="left"
valign="center">
+ Boolean value, so to true, and the replication valve will insert a
request attribute with the name
+ defined by the <code>primaryIndicatorName</code> attribute.
+ The value inserted into the request attribute is either
<code>Boolean.TRUE</code> or
+ <code>Boolean.FALSE</code>
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">primaryIndicatorName</code></td><td align="left"
valign="center">
+ Default value is
<code>org.apache.catalina.ha.tcp.isPrimarySession</code>
+ The value defined here is the name of the request attribute that
contains the boolean value
+ if the session is primary on this server or not.
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">statistics</code></td><td align="left" valign="center">
+ Boolean value. Set to <code>true</code> if you want the valve to
collect request statistics.
+ Default value is <code>false</code>
+ </td></tr></table>
+ </blockquote></td></tr></table>
+</blockquote></td></tr></table><table border="0" cellspacing="0"
cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff"
face="arial,helvetica.sanserif"><a
name="org.apache.catalina.ha.session.JvmRouteBinderValve"><strong>org.apache.catalina.ha.session.JvmRouteBinderValve</strong></a></font></td></tr><tr><td><blockquote>
+ In case of a mod_jk failover, the <code>JvmRouteBinderValve</code> will
replace the
+ <code>jvmWorker</code> attribute in the session Id, to make future requests
stick to this
+ node. If you want failback capability, don't enable this valve, but if you
want your failover to stick,
+ and for mod_jk not to have to keep probing the node that went down, you use
this valve.
+ <table border="0" cellspacing="0" cellpadding="2"><tr><td
bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a
name="org.apache.catalina.ha.session.JvmRouteBinderValve/Attributes"><strong>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">
+ <code>org.apache.catalina.ha.session.JvmRouteBinderValve</code>
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">enabled</code></td><td align="left" valign="center">
+ Default value is <code>true</code>
+ Runtime attribute to turn on and off turn over of the session's
jvmRoute value.
+ </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 is not a Q&A section.
+ The Apache Comments System is explained
+ <a href="/tomcat-8.0-doc/comments.html">here</a>.
+ Comments should be pointed towards suggestions on improving the
documentation
+ or server, and may be removed again by our moderators if they
are either
+ implemented or considered invalid/off-topic.
+ Questions on how to manage Apache Tomcat should be directed
+ to our <a href="http://tomcat.apache.org/lists.html";>mailing
lists</a>.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
+ var comments_shortname = 'tomcat';
+ var comments_identifier =
'http://tomcat.apache.org/tomcat-8.0-doc/config/cluster-valve.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-2012, Apache Software Foundation
+ </em></font></div></td></tr></table></body></html>
\ No newline at end of file
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster-valve.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster-valve.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Added: tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster.html
URL:
http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster.html?rev=1417624&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster.html Wed Dec 5
20:20:35 2012
@@ -0,0 +1,163 @@
+<html><head><META http-equiv="Content-Type" content="text/html;
charset=iso-8859-1"><title>Apache Tomcat 8 Configuration Reference (8.0.0-dev)
- The Cluster 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;}
+ </style><style type="text/css">
+ .wrapped-source code { display: block; background-color:
transparent; }
+ .wrapped-source div { margin: 0 0 0 1.25em; }
+ .wrapped-source p { margin: 0 0 0 1.25em; text-indent: -1.25em; }
+ </style><style type="text/css">
+ 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 8</font></h1><font face="arial,helvetica,sanserif">Version 8.0.0-dev,
Dec 5 2012</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 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">Executo
r</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="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/M
embership</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>Other</strong></p><ul><li><a
href="filter.html">Filter</a></li><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 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="#Engine_vs_Host_placement">Engine vs Host placement</a></li><li><a
href="#Context_Attribute_Replication">Context Attribute
Replication</a></li><li><a href="#Nested_Components">Nested
Components</a></li><li><a href="#Deprecated_configuration_options">Deprecated
configuration options</a></li><li><a
href="#Attributes">Attributes</a><ol><li><a
href="#SimpleTcpCluster_Attributes">SimpleTcpCluster
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 tomcat cluster implementation provides session replication, context
attribute replication and
+ cluster wide WAR file deployment.
+ While the <code>Cluster</code> configuration is fairly complex, the default
configuration will work
+ for most people out of the box. </p><p>
+ The Tomcat Cluster implementation is very extensible, and hence we have
exposed a myriad of options,
+ making the configuration seem like a lot, but don't lose faith, instead you
have a tremendous control
+ over what is going on.</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="Engine vs Host
placement"><!--()--></a><a name="Engine_vs_Host_placement"><strong>Engine vs
Host placement</strong></a></font></td></tr><tr><td><blockquote>
+ <p>
+ You can place the <code><Cluster></code> element inside either the
<code><Engine></code>
+ container or the <code><Host></code> container.<br>
+ Placing it in the engine, means that you will support clustering in all
virtual hosts of Tomcat,
+ and share the messaging component. When you place the
<code><Cluster></code> inside the <code><Engine></code>
+ element, the cluster will append the host name of each session manager to
the managers name so that two contexts with
+ the same name but sitting inside two different hosts will be
distinguishable.
+ </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="Context Attribute
Replication"><!--()--></a><a
name="Context_Attribute_Replication"><strong>Context Attribute
Replication</strong></a></font></td></tr><tr><td><blockquote>
+ <p>To configure context attribute replication, simply do this by swapping
out the context implementation
+ used for your application context.
+ <div align="left"><table cellspacing="4" cellpadding="0"
border="0"><tr><td bgcolor="#023264" width="1" height="1"><img
src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0"
border="0"></td><td bgcolor="#023264" height="1"><img src="../images/void.gif"
alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td
bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt=""
width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td
bgcolor="#023264" width="1"><img src="../images/void.gif" alt="" width="1"
height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff"
height="1"><pre><Context
className="org.apache.catalina.ha.context.ReplicatedContext"/></pre></td><td
bgcolor="#023264" width="1"><img src="../images/void.gif" alt="" width="1"
height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264"
width="1" height="1"><img src="../images/void.gif" alt="" width="1" height="1"
vspac
e="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img
src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0"
border="0"></td><td bgcolor="#023264" width="1" height="1"><img
src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0"
border="0"></td></tr></table></div>
+ This context extends the Tomcat <code><a
href="context.html">StandardContext</a></code>
+ so all the options from the <a href="context.html">base implementation</a>
are valid.
+ </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="Nested Components"><!--()--></a><a
name="Nested_Components"><strong>Nested
Components</strong></a></font></td></tr><tr><td><blockquote>
+ <p><b><a href="cluster-manager.html">Manager</a>:</b> <br>
+ The session manager element identifies what kind of session manager is
used in this cluster implementation.
+ This manager configuration is identical to the one you would use in a
regular <code><a
href="context.html#Nested%20xComponents"><Context></a></code>
configuration.
+ <br>The default value is the
<code>org.apache.catalina.ha.session.DeltaManager</code> that is closely
coupled with
+ the <code>SimpleTcpCluster</code> implementation. Other managers like the
<code>org.apache.catalina.ha.session.BackupManager</code>
+ are/could be loosely coupled and don't rely on the
<code>SimpleTcpCluster</code> for its data replication.
+ </p>
+ <p><b><a href="cluster-channel.html">Channel</a>:</b> <br>
+ The Channel and its sub components are all part of the IO layer
+ for the cluster group, and is a module in it's own that we have nick named
"Tribes"
+ <br>
+ Any configuring and tuning of the network layer, the messaging and the
membership logic
+ will be done in the channel and its nested components.
+ You can always find out more about <a
href="../tribes/introduction.html">Apache Tribes</a>
+ </p>
+ <p><b><a href="cluster-valve.html">Valve</a>:</b> <br>
+ The Tomcat Cluster implementation uses <code>Tomcat <a
href="valve.html">Valves</a></code> to
+ track when requests enter and exit the servlet container. It uses these
valves to be able to make
+ intelligent decisions on when to replicate data, which is always at the
end of a request.
+ </p>
+ <p><b><a href="cluster-deployer.html">Deployer</a>:</b> <br>
+ The Deployer component is the Tomcat Farm Deployer. It allows you to
deploy and undeploy applications
+ cluster wide.
+ </p>
+ <p><b><a href="cluster-listener.html">ClusterListener</a>:</b> <br>
+ ClusterListener's are used to track messages sent and received using the
<code>SimpleTcpCluster</code>.
+ If you wish to track messages, you can add a listener here, or you can add
a valve to the channel object.
+ </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="Deprecated configuration
options"><!--()--></a><a
name="Deprecated_configuration_options"><strong>Deprecated configuration
options</strong></a></font></td></tr><tr><td><blockquote>
+ <p>
+ <b>Deprecated settings:</b> In the previous version of Tomcat you were
able to control session
+ manager settings using manager.<property>=value.
+ This has been discontinued, as the way it was written interferes with
+ the ability to support multiple different manager classes under one
cluster implementation,
+ as the same properties might have the different effect on different
managers.
+ </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="SimpleTcpCluster Attributes"><!--()--></a><a
name="SimpleTcpCluster_Attributes"><strong>SimpleTcpCluster
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 main cluster class, currently only one is available,
+ <code>org.apache.catalina.ha.tcp.SimpleTcpCluster</code>
+ </p>
+ </td></tr><tr><td align="left" valign="center"><strong><code
class="attributeName">channelSendOptions</code></strong></td><td align="left"
valign="center">
+ <p>The Tribes channel send options, default is <code>8</code>.<br>
+ This option is used to set the flag that all messages sent through the
+ SimpleTcpCluster uses. The flag decides how the messages are sent,
and is a simple logical OR.<br>
+
+ <div align="left"><table cellspacing="4" cellpadding="0"
border="0"><tr><td bgcolor="#023264" width="1" height="1"><img
src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0"
border="0"></td><td bgcolor="#023264" height="1"><img src="../images/void.gif"
alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td
bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt=""
width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td
bgcolor="#023264" width="1"><img src="../images/void.gif" alt="" width="1"
height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff"
height="1"><pre>
+ int options= Channel.SEND_OPTIONS_ASYNCHRONOUS |
+ Channel.SEND_OPTIONS_SYNCHRONIZED_ACK |
+ Channel.SEND_OPTIONS_USE_ACK;
+ </pre></td><td bgcolor="#023264" width="1"><img src="../images/void.gif"
alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td
bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt=""
width="1" height="1" vspace="0" hspace="0" border="0"></td><td
bgcolor="#023264" height="1"><img src="../images/void.gif" alt="" width="1"
height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264"
width="1" height="1"><img src="../images/void.gif" alt="" width="1" height="1"
vspace="0" hspace="0" border="0"></td></tr></table></div>
+ Some of the values are:<br>
+ <code>Channel.SEND_OPTIONS_SYNCHRONIZED_ACK = 0x0004</code><br>
+ <code>Channel.SEND_OPTIONS_ASYNCHRONOUS = 0x0008</code><br>
+ <code>Channel.SEND_OPTIONS_USE_ACK = 0x0002</code><br>
+ So to use ACK and ASYNC messaging, the flag would be <code>10 (8+2) or
0x000B</code><br>
+ Note that if you use ASYNC messaging it is possible for update messages
+ for a session to be processed by the receiving nodes in a different order
+ to the order in which they were sent.
+ </p>
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">channelStartOptions</code></td><td align="left"
valign="center">
+ <p>Sets the start and stop flags for the <Channel> object used by
the cluster.
+ The default is <code>Channel.DEFAULT</code> which starts all the
channel services, such as
+ sender, receiver, multicast sender and multicast receiver.
+ The following flags are available today:
+ <div align="left"><table cellspacing="4" cellpadding="0"
border="0"><tr><td bgcolor="#023264" width="1" height="1"><img
src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0"
border="0"></td><td bgcolor="#023264" height="1"><img src="../images/void.gif"
alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td
bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt=""
width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td
bgcolor="#023264" width="1"><img src="../images/void.gif" alt="" width="1"
height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff"
height="1"><pre>
+ Channel.DEFAULT = Channel.SND_RX_SEQ (1)| Channel.SND_TX_SEQ (2)|
Channel.MBR_RX_SEQ (4)| Channel.MBR_TX_SEQ (8);
+ </pre></td><td bgcolor="#023264" width="1"><img
src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0"
border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img
src="../images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0"
border="0"></td><td bgcolor="#023264" height="1"><img src="../images/void.gif"
alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td
bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" alt=""
width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
+ To start a channel without multicasting, you would want to use the
value <code>Channel.SND_RX_SEQ | Channel.SND_TX_SEQ</code>
+ that equals to <code>3</code>.
+ </p>
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">heartbeatBackgroundEnabled</code></td><td align="left"
valign="center">
+ <p>Enable this flag don't forget to disable the channel heartbeat thread.
+ </p>
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">doClusterLog</code></td><td align="left" valign="center">
+ <p><b>Deprecated since 6.0.0</b></p>
+ <p>Possible values are <code>true</code> or <code>false</code><br>
+ Value is inherited from Tomcat 5.5 and has no official meaning.
+ to configure logging, use the standard tomcat logging configuration.
+ </p>
+ </td></tr><tr><td align="left" valign="center"><code
class="attributeName">clusterLogName</code></td><td align="left"
valign="center">
+ <p><b>Deprecated since 6.0.0</b></p>
+ <p>
+ Value is inherited from Tomcat 5.5 and has no official meaning.
+ to configure logging, use the standard tomcat logging configuration.
+ </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 is not a Q&A section.
+ The Apache Comments System is explained
+ <a href="/tomcat-8.0-doc/comments.html">here</a>.
+ Comments should be pointed towards suggestions on improving the
documentation
+ or server, and may be removed again by our moderators if they
are either
+ implemented or considered invalid/off-topic.
+ Questions on how to manage Apache Tomcat should be directed
+ to our <a href="http://tomcat.apache.org/lists.html";>mailing
lists</a>.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
+ var comments_shortname = 'tomcat';
+ var comments_identifier =
'http://tomcat.apache.org/tomcat-8.0-doc/config/cluster.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-2012, Apache Software Foundation
+ </em></font></div></td></tr></table></body></html>
\ No newline at end of file
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/site/trunk/docs/tomcat-8.0-doc/config/cluster.html
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
