Gitiles
Code Review Sign In
source.supwisdom.com / UniIdentify / tomcat / 6266f996613ae5631b7288523f895b36e30fe5af / . / tomcat-uidm / webapps / docs / config / cluster-interceptor.html
blob: a32b1b5090c86c6f758ab21872bec5ccffc4b357 [file] [log] [blame]
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]1<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 Configuration Reference (7.0.77) - The Channel Interceptor object</title><meta name="author" content="Filip Hanik"><style type="text/css" media="print">
2 .noPrint {display: none;}
3 td#mainBody {width: 100%;}
4</style><style type="text/css">
5code {background-color:rgb(224,255,255);padding:0 0.1em;}
6code.attributeName, code.propertyName {background-color:transparent;}
7
8
9table {
10 border-collapse: collapse;
11 text-align: left;
12}
13table *:not(table) {
14 /* Prevent border-collapsing for table child elements like <div> */
15 border-collapse: separate;
16}
17
18th {
19 text-align: left;
20}
21
22
23div.codeBox pre code, code.attributeName, code.propertyName, code.noHighlight, .noHighlight code {
24 background-color: transparent;
25}
26div.codeBox {
27 overflow: auto;
28 margin: 1em 0;
29}
30div.codeBox pre {
31 margin: 0;
32 padding: 4px;
33 border: 1px solid #999;
34 border-radius: 5px;
35 background-color: #eff8ff;
36 display: table; /* To prevent <pre>s from taking the complete available width. */
37 /*
38 When it is officially supported, use the following CSS instead of display: table
39 to prevent big <pre>s from exceeding the browser window:
40 max-width: available;
41 width: min-content;
42 */
43}
44
45div.codeBox pre.wrap {
46 white-space: pre-wrap;
47}
48
49
50table.defaultTable tr, table.detail-table tr {
51 border: 1px solid #CCC;
52}
53
54table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) {
55 background-color: #FAFBFF;
56}
57
58table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) {
59 background-color: #EEEFFF;
60}
61
62table.defaultTable th, table.detail-table th {
63 background-color: #88b;
64 color: #fff;
65}
66
67table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td {
68 padding: 5px 8px;
69}
70
71
72p.notice {
73 border: 1px solid rgb(255, 0, 0);
74 background-color: rgb(238, 238, 238);
75 color: rgb(0, 51, 102);
76 padding: 0.5em;
77 margin: 1em 2em 1em 1em;
78}
79</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="
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]80 The Apache Tomcat Servlet/JSP Container
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]81 " 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 Channel Interceptor 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>
82<ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Available_Interceptors">Available Interceptors</a></li><li><a href="#Static_Membership">Static Membership</a></li><li><a href="#Attributes">Attributes</a><ol><li><a href="#Common_Attributes">Common Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.MessageDispatch15Interceptor_Attributes">org.apache.catalina.tribes.group.interceptors.MessageDispatch15Interceptor Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.TcpFailureDetector_Attributes">org.apache.catalina.tribes.group.interceptors.TcpFailureDetector Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor Attributes</a></li></ol></li><li><a href="#Nested_Components">Nested Components</a><ol><li><a href="#StaticMember_Attributes">StaticMember Attributes</a></li></ol></li></ul>
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]83</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>
84 <p>
85 Apache Tribes supports an interceptor architecture to intercept both messages and membership notifications.
86 This architecture allows decoupling of logic and opens the way for some very kewl feature add ons.
87 </p>
88</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Available Interceptors"><!--()--></a><a name="Available_Interceptors"><strong>Available Interceptors</strong></a></font></td></tr><tr><td><blockquote>
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]89 <ul>
90 <li><code>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector</code></li>
91 <li><code>org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor</code></li>
92 <li><code>org.apache.catalina.tribes.group.interceptors.MessageDispatch15Interceptor</code></li>
93 <li><code>org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor</code></li>
94 <li><code>org.apache.catalina.tribes.group.interceptors.NonBlockingCoordinator</code></li>
95 <li><code>org.apache.catalina.tribes.group.interceptors.OrderInterceptor</code></li>
96 <li><code>org.apache.catalina.tribes.group.interceptors.SimpleCoordinator</code></li>
97 <li><code>org.apache.catalina.tribes.group.interceptors.StaticMembershipInterceptor</code></li>
98 <li><code>org.apache.catalina.tribes.group.interceptors.TwoPhaseCommitInterceptor</code></li>
99 <li><code>org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor</code></li>
100 <li><code>org.apache.catalina.tribes.group.interceptors.FragmentationInterceptor</code></li>
101 <li><code>org.apache.catalina.tribes.group.interceptors.GzipInterceptor</code></li>
102 <li><code>org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor</code></li>
103 </ul>
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]104</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Static Membership"><!--()--></a><a name="Static_Membership"><strong>Static Membership</strong></a></font></td></tr><tr><td><blockquote>
105 <p>
106 In addition to dynamic discovery, Apache Tribes also supports static membership, with membership verification.
107 To achieve this add the <code>org.apache.catalina.tribes.group.interceptors.StaticMembershipInterceptor</code>
108 underneath the <code>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector</code> interceptor.
109 Inside the <code>StaticMembershipInterceptor</code> you can add the static members you wish to have.
110 The <code>TcpFailureDetector</code> will do a health check on the static members,and also monitor them for crashes
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]111 so they will have the same level of notification mechanism as the members that are automatically discovered.</p>
112 <div class="codeBox"><pre><code> &lt;Interceptor className="org.apache.catalina.tribes.group.interceptors.StaticMembershipInterceptor"&gt;
113 &lt;LocalMember className="org.apache.catalina.tribes.membership.StaticMember"
114 domain="staging-cluster"
115 uniqueId="{1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,1}"/&gt;
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]116 &lt;Member className="org.apache.catalina.tribes.membership.StaticMember"
117 port="5678"
118 securePort="-1"
119 host="tomcat01.mydomain.com"
120 domain="staging-cluster"
121 uniqueId="{0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15}"/&gt;
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]122 &lt;/Interceptor&gt;</code></pre></div>
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]123</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>
124
125 <table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Common Attributes"><!--()--></a><a name="Common_Attributes"><strong>Common Attributes</strong></a></font></td></tr><tr><td><blockquote>
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]126 <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">
127 Required, as there is no default
128 </td></tr><tr><td align="left" valign="center"><code class="attributeName">optionFlag</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]129 If you want the interceptor to trigger on certain message depending on the message's option flag,
130 you can setup the interceptors flag here.
131 The default value is <code>0</code>, meaning this interceptor will trigger on all messages.
132 </td></tr></table>
133 </blockquote></td></tr></table>
134
135 <table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor Attributes"><!--()--></a><a name="org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor_Attributes"><strong>org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor Attributes</strong></a></font></td></tr><tr><td><blockquote>
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]136 <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">domain</code></strong></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]137 The logical cluster domain that this Interceptor accepts.
138 Two different type of values are possible:<br>
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]139 1. Regular string values like "staging-domain" or "tomcat-cluster" will be converted into bytes
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]140 using ISO-8859-1 encoding.<br>
141 2. byte array in string form, for example {216,123,12,3}<br>
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]142 </td></tr><tr><td align="left" valign="center"><code class="attributeName">logInterval</code></td><td align="left" valign="center">
143 This value indicates the interval for logging for messages from different domains.
144 The default is 100, which means that to log per 100 messages.
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]145 </td></tr></table>
146 </blockquote></td></tr></table>
147 <table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="org.apache.catalina.tribes.group.interceptors.MessageDispatch15Interceptor Attributes"><!--()--></a><a name="org.apache.catalina.tribes.group.interceptors.MessageDispatch15Interceptor_Attributes"><strong>org.apache.catalina.tribes.group.interceptors.MessageDispatch15Interceptor Attributes</strong></a></font></td></tr><tr><td><blockquote>
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]148 <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">
149 Required, This dispatcher uses JDK 1.5 java.util.concurrent package
150 </td></tr><tr><td align="left" valign="center"><code class="attributeName">optionFlag</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]151 The default and hard coded value is <code>8 (org.apache.catalina.tribes.Channel.SEND_OPTIONS_ASYNCHRONOUS)</code>.
152 The dispatcher will trigger on this value only, as it is predefined by Tribes.
153 The other attributes are inherited from its base class <code>org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor</code>.
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]154 </td></tr><tr><td align="left" valign="center"><code class="attributeName">maxThreads</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]155 The maximum number of threads in this pool, default is 10.
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]156 </td></tr><tr><td align="left" valign="center"><code class="attributeName">maxSpareThreads</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]157 The number of threads to keep in the pool, default is 2.
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]158 </td></tr><tr><td align="left" valign="center"><code class="attributeName">keepAliveTime</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]159 Maximum number of milliseconds of until Idle thread terminates. Default value is 5000(5 seconds).
160 </td></tr></table>
161 </blockquote></td></tr></table>
162 <table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor Attributes"><!--()--></a><a name="org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor_Attributes"><strong>org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor Attributes</strong></a></font></td></tr><tr><td><blockquote>
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]163 <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">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]164 Required, Same implementation as <code>MessageDispatch15Interceptor</code>, but with JDK 1.4 compliance.
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]165 </td></tr><tr><td align="left" valign="center"><code class="attributeName">optionFlag</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]166 The default and hard coded value is <code>8 (org.apache.catalina.tribes.Channel.SEND_OPTIONS_ASYNCHRONOUS)</code>.
167 The dispatcher will trigger on this value only, as it is predefined by Tribes.
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]168 </td></tr><tr><td align="left" valign="center"><code class="attributeName">alwaysSend</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]169 What behavior should be executed when the dispatch queue is full. If <code>true</code> (default), then the message is
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]170 is sent synchronously, if <code>false</code> an error is thrown.
171 </td></tr><tr><td align="left" valign="center"><code class="attributeName">maxQueueSize</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]172 Size in bytes of the dispatch queue, the default value is <code> 1024*1024*64 (64MB)</code> sets the maximum queue size for the dispatch queue
173 if the queue fills up, one can trigger the behavior, if <code>alwaysSend</code> is set to true, the message will be sent synchronously
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]174 if the flag is false, an error is thrown
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]175 </td></tr></table>
176 </blockquote></td></tr></table>
177 <table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="org.apache.catalina.tribes.group.interceptors.TcpFailureDetector Attributes"><!--()--></a><a name="org.apache.catalina.tribes.group.interceptors.TcpFailureDetector_Attributes"><strong>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector Attributes</strong></a></font></td></tr><tr><td><blockquote>
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]178 <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">connectTimeout</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]179 Specifies the timeout, in milliseconds, to use when attempting a TCP connection
180 to the suspect node. Default is 1000.
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]181 </td></tr><tr><td align="left" valign="center"><code class="attributeName">performSendTest</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]182 If true is set, send a test message to the suspect node. Default is true.
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]183 </td></tr><tr><td align="left" valign="center"><code class="attributeName">performReadTest</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]184 If true is set, read the response of the test message that sent. Default is false.
185 <strong>Note: </strong>if <code>performSendTest</code> is false, this attribute will have no effect.
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]186 </td></tr><tr><td align="left" valign="center"><code class="attributeName">readTestTimeout</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]187 Specifies the timeout, in milliseconds, to use when performing a read test
188 to the suspicious node. Default is 5000.
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]189 </td></tr><tr><td align="left" valign="center"><code class="attributeName">removeSuspectsTimeout</code></td><td align="left" valign="center">
190 The maximum time(in seconds) for remove from removeSuspects. Member of
191 removeSuspects will be automatically removed after removeSuspectsTimeout.
192 If a negative value specified, the removeSuspects members never be
193 removed until disappeared really. If the attribute is not provided,
194 a default of 300 seconds (5 minutes) is used.
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]195 </td></tr></table>
196 </blockquote></td></tr></table>
197 <table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor Attributes"><!--()--></a><a name="org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor_Attributes"><strong>org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor Attributes</strong></a></font></td></tr><tr><td><blockquote>
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]198 <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">interval</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]199 If useThread == true, defines the interval of sending a ping message.
200 default is 1000 ms.
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]201 </td></tr><tr><td align="left" valign="center"><code class="attributeName">useThread</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]202 Flag of whether to start a thread for sending a ping message.
203 If set to true, this interceptor will start a local thread for sending a ping message.
204 if set to false, channel heartbeat will send a ping message.
205 default is false.
206 </td></tr></table>
207 </blockquote></td></tr></table>
208 <table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor Attributes"><!--()--></a><a name="org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor_Attributes"><strong>org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor Attributes</strong></a></font></td></tr><tr><td><blockquote>
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]209 <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">interval</code></td><td align="left" valign="center">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]210 Defines the interval in number of messages when we are to report the throughput statistics.
211 The report is logged to the <code>org.apache.juli.logging.LogFactory.getLog(ThroughputInterceptor.class)</code>
212 logger under the <code>INFO</code> level.
213 Default value is to report every <code>10000</code> messages.
214 </td></tr></table>
215 </blockquote></td></tr></table>
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]216</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>
217
218 <table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="StaticMember Attributes"><!--()--></a><a name="StaticMember_Attributes"><strong>StaticMember Attributes</strong></a></font></td></tr><tr><td><blockquote>
219 <p><b>LocalMember:</b> <br>
220 Static member that is the local member of the static cluster group.
221 </p>
222 <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">
223 Only one implementation available:<code>org.apache.catalina.tribes.membership.StaticMember</code>
224 </td></tr><tr><td align="left" valign="center"><code class="attributeName">port</code></td><td align="left" valign="center">
225 There is no need to set.
226 The value of this attribute inherits from the cluster receiver setting.
227 </td></tr><tr><td align="left" valign="center"><code class="attributeName">securePort</code></td><td align="left" valign="center">
228 There is no need to set.
229 The value of this attribute inherits from the cluster receiver setting.
230 </td></tr><tr><td align="left" valign="center"><code class="attributeName">host</code></td><td align="left" valign="center">
231 There is no need to set.
232 The value of this attribute inherits from the cluster receiver setting.
233 </td></tr><tr><td align="left" valign="center"><code class="attributeName">domain</code></td><td align="left" valign="center">
234 The logical cluster domain for that this static member listens for cluster messages.
235 Two different type of values are possible:<br>
236 1. Regular string values like "staging-domain" or "tomcat-cluster" will be converted into bytes
237 using ISO-8859-1 encoding.
238 2. byte array in string form, for example {216,123,12,3}<br>
239 </td></tr><tr><td align="left" valign="center"><strong><code class="attributeName">uniqueId</code></strong></td><td align="left" valign="center">
240 A universally uniqueId for this static member.
241 The values must be 16 bytes in the following form:<br>
242 1. byte array in string form, for example {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15}<br>
243 </td></tr></table>
244
245 <p><b>Member:</b> <br>
246 Static member that add to the static cluster group.
247 </p>
248 <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">
249 Only one implementation available:<code>org.apache.catalina.tribes.membership.StaticMember</code>
250 </td></tr><tr><td align="left" valign="center"><strong><code class="attributeName">port</code></strong></td><td align="left" valign="center">
251 The port that this static member listens to for cluster messages
252 </td></tr><tr><td align="left" valign="center"><code class="attributeName">securePort</code></td><td align="left" valign="center">
253 The secure port this static member listens to for encrypted cluster messages
254 default value is <code>-1</code>, this value means the member is not listening on a secure port
255 </td></tr><tr><td align="left" valign="center"><strong><code class="attributeName">host</code></strong></td><td align="left" valign="center">
256 The host (or network interface) that this static member listens for cluster messages.
257 Three different type of values are possible:<br>
258 1. IP address in the form of "216.123.1.23"<br>
259 2. Hostnames like "tomcat01.mydomain.com" or "tomcat01" as long as they resolve correctly<br>
260 3. byte array in string form, for example {216,123,12,3}<br>
261 </td></tr><tr><td align="left" valign="center"><code class="attributeName">domain</code></td><td align="left" valign="center">
262 The logical cluster domain for that this static member listens for cluster messages.
263 Two different type of values are possible:<br>
264 1. Regular string values like "staging-domain" or "tomcat-cluster" will be converted into bytes
265 using ISO-8859-1 encoding.<br>
266 2. byte array in string form, for example {216,123,12,3}<br>
267 </td></tr><tr><td align="left" valign="center"><strong><code class="attributeName">uniqueId</code></strong></td><td align="left" valign="center">
268 A universally uniqueId for this static member.
269 The values must be 16 bytes in the following form:<br>
270 1. byte array in string form, for example {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15}<br>
271 </td></tr></table>
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]272 </blockquote></td></tr></table>
273
刘洪青6266f992017-05-15 21:21:03 +0800[diff] [blame^]274
275</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
276 on improving documentation for Apache Tomcat.<br><br>
277 If you have trouble and need help, read
278 <a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page
279 and ask your question on the tomcat-users
280 <a href="http://tomcat.apache.org/lists.html">mailing list</a>.
281 Do not ask such questions here. This is not a Q&amp;A section.<br><br>
282 The Apache Comments System is explained <a href="../comments.html">here</a>.
283 Comments may be removed by our moderators if they are either
284 implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
285 var comments_shortname = 'tomcat';
286 var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/config/cluster-interceptor.html';
287 (function(w, d) {
288 if (w.location.hostname.toLowerCase() == "tomcat.apache.org") {
289 d.write('<div id="comments_thread"><\/div>');
290 var s = d.createElement('script');
291 s.type = 'text/javascript';
292 s.async = true;
293 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
294 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
295 }
296 else {
297 d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>');
298 }
299 })(window, document);
300 //--><!]]></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>
301 Copyright &copy; 1999-2017, Apache Software Foundation
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]302 </em></font></div></td></tr></table></body></html>