iosession.html

MINA+API 关于MINA的API

<a name="257" href="#257">257</a> <em class="jxr_javadoccomment">     */</em>
<a name="258" href="#258">258</a>     Object removeAttribute(Object key);
<a name="259" href="#259">259</a> 
<a name="260" href="#260">260</a>     <em class="jxr_javadoccomment">/**</em>
<a name="261" href="#261">261</a> <em class="jxr_javadoccomment">     * Removes a user defined attribute with the specified key if the current</em>
<a name="262" href="#262">262</a> <em class="jxr_javadoccomment">     * attribute value is equal to the specified value.  This method is same</em>
<a name="263" href="#263">263</a> <em class="jxr_javadoccomment">     * with the following code except that the operation is performed</em>
<a name="264" href="#264">264</a> <em class="jxr_javadoccomment">     * atomically.</em>
<a name="265" href="#265">265</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="266" href="#266">266</a> <em class="jxr_javadoccomment">     * if (containsAttribute(key) &amp;&amp; getAttribute(key).equals(value)) {</em>
<a name="267" href="#267">267</a> <em class="jxr_javadoccomment">     *     removeAttribute(key);</em>
<a name="268" href="#268">268</a> <em class="jxr_javadoccomment">     *     return true;</em>
<a name="269" href="#269">269</a> <em class="jxr_javadoccomment">     * } else {</em>
<a name="270" href="#270">270</a> <em class="jxr_javadoccomment">     *     return false;</em>
<a name="271" href="#271">271</a> <em class="jxr_javadoccomment">     * }</em>
<a name="272" href="#272">272</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="273" href="#273">273</a> <em class="jxr_javadoccomment">     */</em>
<a name="274" href="#274">274</a>     <strong class="jxr_keyword">boolean</strong> removeAttribute(Object key, Object value);
<a name="275" href="#275">275</a> 
<a name="276" href="#276">276</a>     <em class="jxr_javadoccomment">/**</em>
<a name="277" href="#277">277</a> <em class="jxr_javadoccomment">     * Replaces a user defined attribute with the specified key if the</em>
<a name="278" href="#278">278</a> <em class="jxr_javadoccomment">     * value of the attribute is equals to the specified old value.</em>
<a name="279" href="#279">279</a> <em class="jxr_javadoccomment">     * This method is same with the following code except that the operation</em>
<a name="280" href="#280">280</a> <em class="jxr_javadoccomment">     * is performed atomically.</em>
<a name="281" href="#281">281</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a name="282" href="#282">282</a> <em class="jxr_javadoccomment">     * if (containsAttribute(key) &amp;&amp; getAttribute(key).equals(oldValue)) {</em>
<a name="283" href="#283">283</a> <em class="jxr_javadoccomment">     *     setAttribute(key, newValue);</em>
<a name="284" href="#284">284</a> <em class="jxr_javadoccomment">     *     return true;</em>
<a name="285" href="#285">285</a> <em class="jxr_javadoccomment">     * } else {</em>
<a name="286" href="#286">286</a> <em class="jxr_javadoccomment">     *     return false;</em>
<a name="287" href="#287">287</a> <em class="jxr_javadoccomment">     * }</em>
<a name="288" href="#288">288</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a name="289" href="#289">289</a> <em class="jxr_javadoccomment">     */</em>
<a name="290" href="#290">290</a>     <strong class="jxr_keyword">boolean</strong> replaceAttribute(Object key, Object oldValue, Object newValue);
<a name="291" href="#291">291</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 &lt;tt&gt;true&lt;/tt&gt; if this session contains the attribute with</em>
<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">     * the specified &lt;tt&gt;key&lt;/tt&gt;.</em>
<a name="295" href="#295">295</a> <em class="jxr_javadoccomment">     */</em>
<a name="296" href="#296">296</a>     <strong class="jxr_keyword">boolean</strong> containsAttribute(Object key);
<a name="297" href="#297">297</a> 
<a name="298" href="#298">298</a>     <em class="jxr_javadoccomment">/**</em>
<a name="299" href="#299">299</a> <em class="jxr_javadoccomment">     * Returns the set of keys of all user-defined attributes.</em>
<a name="300" href="#300">300</a> <em class="jxr_javadoccomment">     */</em>
<a name="301" href="#301">301</a>     Set&lt;Object&gt; getAttributeKeys();
<a name="302" href="#302">302</a> 
<a name="303" href="#303">303</a>     <em class="jxr_javadoccomment">/**</em>
<a name="304" href="#304">304</a> <em class="jxr_javadoccomment">     * Returns &lt;code&gt;true&lt;/code&gt; if this session is connected with remote peer.</em>
<a name="305" href="#305">305</a> <em class="jxr_javadoccomment">     */</em>
<a name="306" href="#306">306</a>     <strong class="jxr_keyword">boolean</strong> isConnected();
<a name="307" href="#307">307</a> 
<a name="308" href="#308">308</a>     <em class="jxr_javadoccomment">/**</em>
<a name="309" href="#309">309</a> <em class="jxr_javadoccomment">     * Returns &lt;code&gt;true&lt;/tt&gt; if and only if this session is being closed</em>
<a name="310" href="#310">310</a> <em class="jxr_javadoccomment">     * (but not disconnected yet) or is closed.</em>
<a name="311" href="#311">311</a> <em class="jxr_javadoccomment">     */</em>
<a name="312" href="#312">312</a>     <strong class="jxr_keyword">boolean</strong> isClosing();
<a name="313" href="#313">313</a> 
<a name="314" href="#314">314</a>     <em class="jxr_javadoccomment">/**</em>
<a name="315" href="#315">315</a> <em class="jxr_javadoccomment">     * Returns the {@link CloseFuture} of this session.  This method returns</em>
<a name="316" href="#316">316</a> <em class="jxr_javadoccomment">     * the same instance whenever user calls it.</em>
<a name="317" href="#317">317</a> <em class="jxr_javadoccomment">     */</em>
<a name="318" href="#318">318</a>     <a href="../../../../org/apache/mina/common/CloseFuture.html">CloseFuture</a> getCloseFuture();
<a name="319" href="#319">319</a> 
<a name="320" href="#320">320</a>     <em class="jxr_javadoccomment">/**</em>
<a name="321" href="#321">321</a> <em class="jxr_javadoccomment">     * Returns the socket address of remote peer.</em>
<a name="322" href="#322">322</a> <em class="jxr_javadoccomment">     */</em>
<a name="323" href="#323">323</a>     SocketAddress getRemoteAddress();
<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">     * Returns the socket address of local machine which is associated with this</em>
<a name="327" href="#327">327</a> <em class="jxr_javadoccomment">     * session.</em>
<a name="328" href="#328">328</a> <em class="jxr_javadoccomment">     */</em>
<a name="329" href="#329">329</a>     SocketAddress getLocalAddress();
<a name="330" href="#330">330</a> 
<a name="331" href="#331">331</a>     <em class="jxr_javadoccomment">/**</em>
<a name="332" href="#332">332</a> <em class="jxr_javadoccomment">     * Returns the socket address of the {@link IoService} listens to to manage</em>
<a name="333" href="#333">333</a> <em class="jxr_javadoccomment">     * this session.  If this session is managed by {@link IoAcceptor}, it</em>
<a name="334" href="#334">334</a> <em class="jxr_javadoccomment">     * returns the {@link SocketAddress} which is specified as a parameter of</em>
<a name="335" href="#335">335</a> <em class="jxr_javadoccomment">     * {@link IoAcceptor#bind()}.  If this session is managed by</em>
<a name="336" href="#336">336</a> <em class="jxr_javadoccomment">     * {@link IoConnector}, this method returns the same address with</em>
<a name="337" href="#337">337</a> <em class="jxr_javadoccomment">     * that of {@link #getRemoteAddress()}.</em>
<a name="338" href="#338">338</a> <em class="jxr_javadoccomment">     */</em>
<a name="339" href="#339">339</a>     SocketAddress getServiceAddress();
<a name="340" href="#340">340</a> 
<a name="341" href="#341">341</a>     <em class="jxr_javadoccomment">/**</em>
<a name="342" href="#342">342</a> <em class="jxr_javadoccomment">     * Returns the current {@link TrafficMask} of this session.</em>
<a name="343" href="#343">343</a> <em class="jxr_javadoccomment">     */</em>
<a name="344" href="#344">344</a>     <a href="../../../../org/apache/mina/common/TrafficMask.html">TrafficMask</a> getTrafficMask();
<a name="345" href="#345">345</a> 
<a name="346" href="#346">346</a>     <em class="jxr_javadoccomment">/**</em>
<a name="347" href="#347">347</a> <em class="jxr_javadoccomment">     * Sets the {@link TrafficMask} of this session which will result</em>
<a name="348" href="#348">348</a> <em class="jxr_javadoccomment">     * the parent {@link IoService} to start to control the traffic</em>
<a name="349" href="#349">349</a> <em class="jxr_javadoccomment">     * of this session immediately.</em>
<a name="350" href="#350">350</a> <em class="jxr_javadoccomment">     */</em>
<a name="351" href="#351">351</a>     <strong class="jxr_keyword">void</strong> setTrafficMask(<a href="../../../../org/apache/mina/common/TrafficMask.html">TrafficMask</a> trafficMask);
<a name="352" href="#352">352</a> 
<a name="353" href="#353">353</a>     <em class="jxr_javadoccomment">/**</em>
<a name="354" href="#354">354</a> <em class="jxr_javadoccomment">     * A shortcut method for {@link #setTrafficMask(TrafficMask)} that</em>
<a name="355" href="#355">355</a> <em class="jxr_javadoccomment">     * suspends read operations for this session.</em>
<a name="356" href="#356">356</a> <em class="jxr_javadoccomment">     */</em>
<a name="357" href="#357">357</a>     <strong class="jxr_keyword">void</strong> suspendRead();
<a name="358" href="#358">358</a> 
<a name="359" href="#359">359</a>     <em class="jxr_javadoccomment">/**</em>
<a name="360" href="#360">360</a> <em class="jxr_javadoccomment">     * A shortcut method for {@link #setTrafficMask(TrafficMask)} that</em>
<a name="361" href="#361">361</a> <em class="jxr_javadoccomment">     * suspends write operations for this session.</em>
<a name="362" href="#362">362</a> <em class="jxr_javadoccomment">     */</em>
<a name="363" href="#363">363</a>     <strong class="jxr_keyword">void</strong> suspendWrite();
<a name="364" href="#364">364</a> 
<a name="365" href="#365">365</a>     <em class="jxr_javadoccomment">/**</em>
<a name="366" href="#366">366</a> <em class="jxr_javadoccomment">     * A shortcut method for {@link #setTrafficMask(TrafficMask)} that</em>
<a name="367" href="#367">367</a> <em class="jxr_javadoccomment">     * resumes read operations for this session.</em>
<a name="368" href="#368">368</a> <em class="jxr_javadoccomment">     */</em>
<a name="369" href="#369">369</a>     <strong class="jxr_keyword">void</strong> resumeRead();
<a name="370" href="#370">370</a> 
<a name="371" href="#371">371</a>     <em class="jxr_javadoccomment">/**</em>
<a name="372" href="#372">372</a> <em class="jxr_javadoccomment">     * A shortcut method for {@link #setTrafficMask(TrafficMask)} that</em>
<a name="373" href="#373">373</a> <em class="jxr_javadoccomment">     * resumes write operations for this session.</em>
<a name="374" href="#374">374</a> <em class="jxr_javadoccomment">     */</em>
<a name="375" href="#375">375</a>     <strong class="jxr_keyword">void</strong> resumeWrite();
<a name="376" href="#376">376</a> 
<a name="377" href="#377">377</a>     <em class="jxr_javadoccomment">/**</em>
<a name="378" href="#378">378</a> <em class="jxr_javadoccomment">     * Returns the total number of bytes which were read from this session.</em>
<a name="379" href="#379">379</a> <em class="jxr_javadoccomment">     */</em>
<a name="380" href="#380">380</a>     <strong class="jxr_keyword">long</strong> getReadBytes();
<a name="381" href="#381">381</a> 
<a name="382" href="#382">382</a>     <em class="jxr_javadoccomment">/**</em>
<a name="383" href="#383">383</a> <em class="jxr_javadoccomment">     * Returns the total number of bytes which were written to this session.</em>
<a name="384" href="#384">384</a> <em class="jxr_javadoccomment">     */</em>
<a name="385" href="#385">385</a>     <strong class="jxr_keyword">long</strong> getWrittenBytes();
<a name="386" href="#386">386</a> 
<a name="387" href="#387">387</a>     <em class="jxr_javadoccomment">/**</em>
<a name="388" href="#388">388</a> <em class="jxr_javadoccomment">     * Returns the total number of messages which were read and decoded from this session.</em>
<a name="389" href="#389">389</a> <em class="jxr_javadoccomment">     */</em>