keepalivefilter.html

MINA+API 关于MINA的API

<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * whatever case you chose.</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * </em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * &lt;h2&gt;Enforcing a policy&lt;/h2&gt;</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * </em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * You can enforce a predefined policy by specifying a {@link KeepAlivePolicy}.</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * The default policy is {@link KeepAlivePolicy#CLOSE}.  Setting the policy</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * to {@link KeepAlivePolicy#OFF} stops this filter from waiting for response</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * messages and therefore disables &lt;tt&gt;keepAliveRequestTimeout&lt;/tt&gt; property.</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> *  </em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @author The Apache MINA Project ([e-mail])</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @version $Rev: 616100 $, $Date: 2008-01-28 15:58:32 -0700 (Mon, 28 Jan 2008) $</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> */</em>
<a name="122" href="#122">122</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/mina/filter/keepalive/KeepAliveFilter.html">KeepAliveFilter</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/mina/common/IoFilterAdapter.html">IoFilterAdapter</a> {
<a name="123" href="#123">123</a>     
<a name="124" href="#124">124</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/common/AttributeKey.html">AttributeKey</a> WAITING_FOR_RESPONSE = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/mina/common/AttributeKey.html">AttributeKey</a>(
<a name="125" href="#125">125</a>             getClass(), <span class="jxr_string">"waitingForResponse"</span>);
<a name="126" href="#126">126</a> 
<a name="127" href="#127">127</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/filter/keepalive/KeepAliveMessageFactory.html">KeepAliveMessageFactory</a> messageFactory;
<a name="128" href="#128">128</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">volatile</strong> <a href="../../../../../org/apache/mina/filter/keepalive/KeepAlivePolicy.html">KeepAlivePolicy</a> policy;
<a name="129" href="#129">129</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">volatile</strong> <strong class="jxr_keyword">int</strong> keepAliveRequestInterval;
<a name="130" href="#130">130</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">volatile</strong> <strong class="jxr_keyword">int</strong> keepAliveRequestTimeout;
<a name="131" href="#131">131</a> 
<a name="132" href="#132">132</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Logger logger = LoggerFactory.getLogger(getClass());
<a name="133" href="#133">133</a>     
<a name="134" href="#134">134</a>     <em class="jxr_javadoccomment">/**</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     * Creates a new instance with the default {@link KeepAlivePolicy} and</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">     * the default timeout values (&lt;tt&gt;policy&lt;/tt&gt; =</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">     * {@link KeepAlivePolicy#CLOSE}, &lt;tt&gt;keepAliveRequestInterval = 60&lt;/tt&gt;</em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment">     * and &lt;tt&gt;keepAliveRequestTimeout = 30&lt;/tt&gt;).</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment">     */</em>
<a name="140" href="#140">140</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/keepalive/KeepAliveFilter.html">KeepAliveFilter</a>(<a href="../../../../../org/apache/mina/filter/keepalive/KeepAliveMessageFactory.html">KeepAliveMessageFactory</a> messageFactory) {
<a name="141" href="#141">141</a>         <strong class="jxr_keyword">this</strong>(messageFactory, KeepAlivePolicy.CLOSE);
<a name="142" href="#142">142</a>     }
<a name="143" href="#143">143</a>     
<a name="144" href="#144">144</a>     <em class="jxr_javadoccomment">/**</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     * Creates a new instance with the default timeout values</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     * (&lt;tt&gt;keepAliveRequestInterval = 60&lt;/tt&gt; and</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">     * &lt;tt&gt;keepAliveRequestTimeout = 30&lt;/tt&gt;).</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">     */</em>
<a name="149" href="#149">149</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/keepalive/KeepAliveFilter.html">KeepAliveFilter</a>(
<a name="150" href="#150">150</a>             <a href="../../../../../org/apache/mina/filter/keepalive/KeepAliveMessageFactory.html">KeepAliveMessageFactory</a> messageFactory, <a href="../../../../../org/apache/mina/filter/keepalive/KeepAlivePolicy.html">KeepAlivePolicy</a> policy) {
<a name="151" href="#151">151</a>         <strong class="jxr_keyword">this</strong>(messageFactory, policy, 60, 30);
<a name="152" href="#152">152</a>     }
<a name="153" href="#153">153</a> 
<a name="154" href="#154">154</a>     <em class="jxr_javadoccomment">/**</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     * Creates a new instance.</em>
<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">     */</em>
<a name="157" href="#157">157</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/keepalive/KeepAliveFilter.html">KeepAliveFilter</a>(
<a name="158" href="#158">158</a>             <a href="../../../../../org/apache/mina/filter/keepalive/KeepAliveMessageFactory.html">KeepAliveMessageFactory</a> messageFactory, <a href="../../../../../org/apache/mina/filter/keepalive/KeepAlivePolicy.html">KeepAlivePolicy</a> policy,
<a name="159" href="#159">159</a>             <strong class="jxr_keyword">int</strong> keepAliveRequestInterval, <strong class="jxr_keyword">int</strong> keepAliveRequestTimeout) {
<a name="160" href="#160">160</a>         <strong class="jxr_keyword">if</strong> (messageFactory == <strong class="jxr_keyword">null</strong>) {
<a name="161" href="#161">161</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"messageFactory"</span>);
<a name="162" href="#162">162</a>         }
<a name="163" href="#163">163</a>         <strong class="jxr_keyword">if</strong> (policy == <strong class="jxr_keyword">null</strong>) {
<a name="164" href="#164">164</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"policy"</span>);
<a name="165" href="#165">165</a>         }
<a name="166" href="#166">166</a>         
<a name="167" href="#167">167</a>         <strong class="jxr_keyword">this</strong>.messageFactory = messageFactory;
<a name="168" href="#168">168</a>         <strong class="jxr_keyword">this</strong>.policy = policy;
<a name="169" href="#169">169</a>         
<a name="170" href="#170">170</a>         setKeepAliveRequestInterval(keepAliveRequestInterval);
<a name="171" href="#171">171</a>         setKeepAliveRequestTimeout(keepAliveRequestTimeout);
<a name="172" href="#172">172</a>     }
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/keepalive/KeepAlivePolicy.html">KeepAlivePolicy</a> getPolicy() {
<a name="175" href="#175">175</a>         <strong class="jxr_keyword">return</strong> policy;
<a name="176" href="#176">176</a>     }
<a name="177" href="#177">177</a> 
<a name="178" href="#178">178</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPolicy(<a href="../../../../../org/apache/mina/filter/keepalive/KeepAlivePolicy.html">KeepAlivePolicy</a> policy) {
<a name="179" href="#179">179</a>         <strong class="jxr_keyword">if</strong> (policy == <strong class="jxr_keyword">null</strong>) {
<a name="180" href="#180">180</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"policy"</span>);
<a name="181" href="#181">181</a>         }
<a name="182" href="#182">182</a>         <strong class="jxr_keyword">this</strong>.policy = policy;
<a name="183" href="#183">183</a>     }
<a name="184" href="#184">184</a> 
<a name="185" href="#185">185</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getKeepAliveRequestInterval() {
<a name="186" href="#186">186</a>         <strong class="jxr_keyword">return</strong> keepAliveRequestInterval;
<a name="187" href="#187">187</a>     }
<a name="188" href="#188">188</a> 
<a name="189" href="#189">189</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setKeepAliveRequestInterval(<strong class="jxr_keyword">int</strong> keepAliveRequestInterval) {
<a name="190" href="#190">190</a>         <strong class="jxr_keyword">if</strong> (keepAliveRequestInterval &lt;= 0) {
<a name="191" href="#191">191</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a name="192" href="#192">192</a>                     <span class="jxr_string">"keepAliveRequestInterval must be a positive integer: "</span> +
<a name="193" href="#193">193</a>                     keepAliveRequestInterval);
<a name="194" href="#194">194</a>         }
<a name="195" href="#195">195</a>         <strong class="jxr_keyword">this</strong>.keepAliveRequestInterval = keepAliveRequestInterval;
<a name="196" href="#196">196</a>     }
<a name="197" href="#197">197</a> 
<a name="198" href="#198">198</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getKeepAliveRequestTimeout() {
<a name="199" href="#199">199</a>         <strong class="jxr_keyword">return</strong> keepAliveRequestTimeout;
<a name="200" href="#200">200</a>     }
<a name="201" href="#201">201</a> 
<a name="202" href="#202">202</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setKeepAliveRequestTimeout(<strong class="jxr_keyword">int</strong> keepAliveRequestTimeout) {
<a name="203" href="#203">203</a>         <strong class="jxr_keyword">if</strong> (keepAliveRequestTimeout &lt;= 0) {
<a name="204" href="#204">204</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a name="205" href="#205">205</a>                     <span class="jxr_string">"keepAliveRequestTimeout must be a positive integer: "</span> +
<a name="206" href="#206">206</a>                     keepAliveRequestTimeout);
<a name="207" href="#207">207</a>         }
<a name="208" href="#208">208</a>         <strong class="jxr_keyword">this</strong>.keepAliveRequestTimeout = keepAliveRequestTimeout;
<a name="209" href="#209">209</a>     }
<a name="210" href="#210">210</a> 
<a name="211" href="#211">211</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/keepalive/KeepAliveMessageFactory.html">KeepAliveMessageFactory</a> getMessageFactory() {
<a name="212" href="#212">212</a>         <strong class="jxr_keyword">return</strong> messageFactory;
<a name="213" href="#213">213</a>     }
<a name="214" href="#214">214</a> 
<a name="215" href="#215">215</a>     @Override
<a name="216" href="#216">216</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onPreAdd(<a href="../../../../../org/apache/mina/common/IoFilterChain.html">IoFilterChain</a> parent, String name,
<a name="217" href="#217">217</a>             <a href="../../../../../org/apache/mina/common/IoFilter.html">NextFilter</a> nextFilter) <strong class="jxr_keyword">throws</strong> Exception {
<a name="218" href="#218">218</a>         <strong class="jxr_keyword">if</strong> (parent.contains(<strong class="jxr_keyword">this</strong>)) {
<a name="219" href="#219">219</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a name="220" href="#220">220</a>                     <span class="jxr_string">"You can't add the same filter instance more than once. "</span> +
<a name="221" href="#221">221</a>                     <span class="jxr_string">"Create another instance and add it."</span>);
<a name="222" href="#222">222</a>         }
<a name="223" href="#223">223</a>     }
<a name="224" href="#224">224</a> 
<a name="225" href="#225">225</a>     @Override
<a name="226" href="#226">226</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onPostAdd(
<a name="227" href="#227">227</a>             <a href="../../../../../org/apache/mina/common/IoFilterChain.html">IoFilterChain</a> parent, String name, <a href="../../../../../org/apache/mina/common/IoFilter.html">NextFilter</a> nextFilter) <strong class="jxr_keyword">throws</strong> Exception {
<a name="228" href="#228">228</a>         resetStatus(parent.getSession());