iofilterchain.html

MINA+API 关于MINA的API

<a name="227" href="#227">227</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fireSessionOpened();
<a name="228" href="#228">228</a> 
<a name="229" href="#229">229</a>     <em class="jxr_javadoccomment">/**</em>
<a name="230" href="#230">230</a> <em class="jxr_javadoccomment">     * Fires a {@link IoHandler#sessionClosed(IoSession)} event.  Most users don't need to call</em>
<a name="231" href="#231">231</a> <em class="jxr_javadoccomment">     * this method at all.  Please use this method only when you implement a new transport or</em>
<a name="232" href="#232">232</a> <em class="jxr_javadoccomment">     * fire a virtual event.</em>
<a name="233" href="#233">233</a> <em class="jxr_javadoccomment">     */</em>
<a name="234" href="#234">234</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fireSessionClosed();
<a name="235" href="#235">235</a> 
<a name="236" href="#236">236</a>     <em class="jxr_javadoccomment">/**</em>
<a name="237" href="#237">237</a> <em class="jxr_javadoccomment">     * Fires a {@link IoHandler#sessionIdle(IoSession, IdleStatus)} event.  Most users don't</em>
<a name="238" href="#238">238</a> <em class="jxr_javadoccomment">     * need to call this method at all.  Please use this method only when you implement a new</em>
<a name="239" href="#239">239</a> <em class="jxr_javadoccomment">     * transport or fire a virtual event.</em>
<a name="240" href="#240">240</a> <em class="jxr_javadoccomment">     */</em>
<a name="241" href="#241">241</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fireSessionIdle(<a href="../../../../org/apache/mina/common/IdleStatus.html">IdleStatus</a> status);
<a name="242" href="#242">242</a> 
<a name="243" href="#243">243</a>     <em class="jxr_javadoccomment">/**</em>
<a name="244" href="#244">244</a> <em class="jxr_javadoccomment">     * Fires a {@link #fireMessageReceived(Object)} event.  Most users don't need to</em>
<a name="245" href="#245">245</a> <em class="jxr_javadoccomment">     * call this method at all.  Please use this method only when you implement a new transport</em>
<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">     * or fire a virtual event.</em>
<a name="247" href="#247">247</a> <em class="jxr_javadoccomment">     */</em>
<a name="248" href="#248">248</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fireMessageReceived(Object message);
<a name="249" href="#249">249</a> 
<a name="250" href="#250">250</a>     <em class="jxr_javadoccomment">/**</em>
<a name="251" href="#251">251</a> <em class="jxr_javadoccomment">     * Fires a {@link IoHandler#sessionOpened(IoSession)} event.  Most users don't need to call</em>
<a name="252" href="#252">252</a> <em class="jxr_javadoccomment">     * this method at all.  Please use this method only when you implement a new transport or</em>
<a name="253" href="#253">253</a> <em class="jxr_javadoccomment">     * fire a virtual event.</em>
<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">     */</em>
<a name="255" href="#255">255</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fireMessageSent(<a href="../../../../org/apache/mina/common/WriteRequest.html">WriteRequest</a> request);
<a name="256" href="#256">256</a> 
<a name="257" href="#257">257</a>     <em class="jxr_javadoccomment">/**</em>
<a name="258" href="#258">258</a> <em class="jxr_javadoccomment">     * Fires a {@link IoHandler#exceptionCaught(IoSession, Throwable)} event.  Most users don't</em>
<a name="259" href="#259">259</a> <em class="jxr_javadoccomment">     * need to call this method at all.  Please use this method only when you implement a new</em>
<a name="260" href="#260">260</a> <em class="jxr_javadoccomment">     * transport or fire a virtual event.</em>
<a name="261" href="#261">261</a> <em class="jxr_javadoccomment">     */</em>
<a name="262" href="#262">262</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fireExceptionCaught(Throwable cause);
<a name="263" href="#263">263</a> 
<a name="264" href="#264">264</a>     <em class="jxr_javadoccomment">/**</em>
<a name="265" href="#265">265</a> <em class="jxr_javadoccomment">     * Fires a {@link IoSession#write(Object)} event.  Most users don't need to call this</em>
<a name="266" href="#266">266</a> <em class="jxr_javadoccomment">     * method at all.  Please use this method only when you implement a new transport or fire a</em>
<a name="267" href="#267">267</a> <em class="jxr_javadoccomment">     * virtual event.</em>
<a name="268" href="#268">268</a> <em class="jxr_javadoccomment">     */</em>
<a name="269" href="#269">269</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fireFilterWrite(<a href="../../../../org/apache/mina/common/WriteRequest.html">WriteRequest</a> writeRequest);
<a name="270" href="#270">270</a> 
<a name="271" href="#271">271</a>     <em class="jxr_javadoccomment">/**</em>
<a name="272" href="#272">272</a> <em class="jxr_javadoccomment">     * Fires a {@link IoSession#close()} event.  Most users don't need to call this method at</em>
<a name="273" href="#273">273</a> <em class="jxr_javadoccomment">     * all.  Please use this method only when you implement a new transport or fire a virtual</em>
<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">     * event.</em>
<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">     */</em>
<a name="276" href="#276">276</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fireFilterClose();
<a name="277" href="#277">277</a> 
<a name="278" href="#278">278</a>     <em class="jxr_javadoccomment">/**</em>
<a name="279" href="#279">279</a> <em class="jxr_javadoccomment">     * Fires a {@link IoSession#setTrafficMask(TrafficMask)} event.  Most users don't need to call this method at</em>
<a name="280" href="#280">280</a> <em class="jxr_javadoccomment">     * all.  Please use this method only when you implement a new transport or fire a virtual</em>
<a name="281" href="#281">281</a> <em class="jxr_javadoccomment">     * event.</em>
<a name="282" href="#282">282</a> <em class="jxr_javadoccomment">     */</em>
<a name="283" href="#283">283</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fireFilterSetTrafficMask(<a href="../../../../org/apache/mina/common/TrafficMask.html">TrafficMask</a> trafficMask);
<a name="284" href="#284">284</a> 
<a name="285" href="#285">285</a>     <em class="jxr_javadoccomment">/**</em>
<a name="286" href="#286">286</a> <em class="jxr_javadoccomment">     * Represents a name-filter pair that an {@link IoFilterChain} contains.</em>
<a name="287" href="#287">287</a> <em class="jxr_javadoccomment">     *</em>
<a name="288" href="#288">288</a> <em class="jxr_javadoccomment">     * @author The Apache MINA Project ([e-mail])</em>
<a name="289" href="#289">289</a> <em class="jxr_javadoccomment">     * @version $Rev: 593474 $, $Date: 2007-11-09 03:14:12 -0700 (Fri, 09 Nov 2007) $</em>
<a name="290" href="#290">290</a> <em class="jxr_javadoccomment">     */</em>
<a name="291" href="#291">291</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/mina/common/IoFilterChain.html">Entry</a> {
<a name="292" href="#292">292</a>         <em class="jxr_javadoccomment">/**</em>
<a name="293" href="#293">293</a> <em class="jxr_javadoccomment">         * Returns the name of the filter.</em>
<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">         */</em>
<a name="295" href="#295">295</a>         String getName();
<a name="296" href="#296">296</a> 
<a name="297" href="#297">297</a>         <em class="jxr_javadoccomment">/**</em>
<a name="298" href="#298">298</a> <em class="jxr_javadoccomment">         * Returns the filter.</em>
<a name="299" href="#299">299</a> <em class="jxr_javadoccomment">         */</em>
<a name="300" href="#300">300</a>         <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> getFilter();
<a name="301" href="#301">301</a> 
<a name="302" href="#302">302</a>         <em class="jxr_javadoccomment">/**</em>
<a name="303" href="#303">303</a> <em class="jxr_javadoccomment">         * Returns the {@link NextFilter} of the filter.</em>
<a name="304" href="#304">304</a> <em class="jxr_javadoccomment">         *</em>
<a name="305" href="#305">305</a> <em class="jxr_javadoccomment">         * @throws IllegalStateException if the {@link NextFilter} is not available</em>
<a name="306" href="#306">306</a> <em class="jxr_javadoccomment">         */</em>
<a name="307" href="#307">307</a>         <a href="../../../../org/apache/mina/common/IoFilter.html">NextFilter</a> getNextFilter();
<a name="308" href="#308">308</a>         
<a name="309" href="#309">309</a>         <em class="jxr_javadoccomment">/**</em>
<a name="310" href="#310">310</a> <em class="jxr_javadoccomment">         * Adds the specified filter with the specified name just before this entry.</em>
<a name="311" href="#311">311</a> <em class="jxr_javadoccomment">         * @throws IoFilterLifeCycleException</em>
<a name="312" href="#312">312</a> <em class="jxr_javadoccomment">         *             if {@link IoFilter#onPostAdd(IoFilterChain, String, NextFilter)} or</em>
<a name="313" href="#313">313</a> <em class="jxr_javadoccomment">         *             {@link IoFilter#init()} throws an exception.</em>
<a name="314" href="#314">314</a> <em class="jxr_javadoccomment">         */</em>
<a name="315" href="#315">315</a>         <strong class="jxr_keyword">void</strong> addBefore(String name, <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> filter);
<a name="316" href="#316">316</a> 
<a name="317" href="#317">317</a>         <em class="jxr_javadoccomment">/**</em>
<a name="318" href="#318">318</a> <em class="jxr_javadoccomment">         * Adds the specified filter with the specified name just after this entry.</em>
<a name="319" href="#319">319</a> <em class="jxr_javadoccomment">         * @throws IoFilterLifeCycleException</em>
<a name="320" href="#320">320</a> <em class="jxr_javadoccomment">         *             if {@link IoFilter#onPostAdd(IoFilterChain, String, NextFilter)} or</em>
<a name="321" href="#321">321</a> <em class="jxr_javadoccomment">         *             {@link IoFilter#init()} throws an exception.</em>
<a name="322" href="#322">322</a> <em class="jxr_javadoccomment">         */</em>
<a name="323" href="#323">323</a>         <strong class="jxr_keyword">void</strong> addAfter(String name, <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> filter);
<a name="324" href="#324">324</a> 
<a name="325" href="#325">325</a>         <em class="jxr_javadoccomment">/**</em>
<a name="326" href="#326">326</a> <em class="jxr_javadoccomment">         * Replace the filter of this entry with the specified new filter.</em>
<a name="327" href="#327">327</a> <em class="jxr_javadoccomment">         *</em>
<a name="328" href="#328">328</a> <em class="jxr_javadoccomment">         * @throws IllegalArgumentException if there's no such filter</em>
<a name="329" href="#329">329</a> <em class="jxr_javadoccomment">         */</em>
<a name="330" href="#330">330</a>         <strong class="jxr_keyword">void</strong> replace(<a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> newFilter);
<a name="331" href="#331">331</a>         
<a name="332" href="#332">332</a>         <em class="jxr_javadoccomment">/**</em>
<a name="333" href="#333">333</a> <em class="jxr_javadoccomment">         * Removes this entry from the chain it belongs to.</em>
<a name="334" href="#334">334</a> <em class="jxr_javadoccomment">         */</em>
<a name="335" href="#335">335</a>         <strong class="jxr_keyword">void</strong> remove();
<a name="336" href="#336">336</a>     }
<a name="337" href="#337">337</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>