ioservice.html

MINA+API 关于MINA的API

<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">     *</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     * 	whether of not the service is active.</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     */</em>
<a name="147" href="#147">147</a>     <strong class="jxr_keyword">boolean</strong> isActive();
<a name="148" href="#148">148</a> 
<a name="149" href="#149">149</a>     <em class="jxr_javadoccomment">/**</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">     * Returns the time when this service was activated.  It returns the last</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">     * time when this service was activated if the service is not active now.</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     *</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     * @return</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">     * 	The time by using {@link System#currentTimeMillis()}</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     */</em>
<a name="156" href="#156">156</a>     <strong class="jxr_keyword">long</strong> getActivationTime();
<a name="157" href="#157">157</a> 
<a name="158" href="#158">158</a>     <em class="jxr_javadoccomment">/**</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * Returns the time in millis when I/O occurred lastly.</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">     */</em>
<a name="161" href="#161">161</a>     <strong class="jxr_keyword">long</strong> getLastIoTime();
<a name="162" href="#162">162</a> 
<a name="163" href="#163">163</a>     <em class="jxr_javadoccomment">/**</em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     * Returns the time in millis when read operation occurred lastly.</em>
<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">     */</em>
<a name="166" href="#166">166</a>     <strong class="jxr_keyword">long</strong> getLastReadTime();
<a name="167" href="#167">167</a> 
<a name="168" href="#168">168</a>     <em class="jxr_javadoccomment">/**</em>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">     * Returns the time in millis when write operation occurred lastly.</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     */</em>
<a name="171" href="#171">171</a>     <strong class="jxr_keyword">long</strong> getLastWriteTime();
<a name="172" href="#172">172</a>     
<a name="173" href="#173">173</a>     <em class="jxr_javadoccomment">/**</em>
<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">     * Returns &lt;code&gt;true&lt;/code&gt; if this service is idle for the specified</em>
<a name="175" href="#175">175</a> <em class="jxr_javadoccomment">     * {@link IdleStatus}.</em>
<a name="176" href="#176">176</a> <em class="jxr_javadoccomment">     */</em>
<a name="177" href="#177">177</a>     <strong class="jxr_keyword">boolean</strong> isIdle(<a href="../../../../org/apache/mina/common/IdleStatus.html">IdleStatus</a> status);
<a name="178" href="#178">178</a>     
<a name="179" href="#179">179</a>     <em class="jxr_javadoccomment">/**</em>
<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">     * Returns &lt;code&gt;true&lt;/code&gt; if this service is {@link IdleStatus#READER_IDLE}.</em>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">     * @see #isIdle(IdleStatus)</em>
<a name="182" href="#182">182</a> <em class="jxr_javadoccomment">     */</em>
<a name="183" href="#183">183</a>     <strong class="jxr_keyword">boolean</strong> isReaderIdle();
<a name="184" href="#184">184</a>     
<a name="185" href="#185">185</a>     <em class="jxr_javadoccomment">/**</em>
<a name="186" href="#186">186</a> <em class="jxr_javadoccomment">     * Returns &lt;code&gt;true&lt;/code&gt; if this service is {@link IdleStatus#WRITER_IDLE}.</em>
<a name="187" href="#187">187</a> <em class="jxr_javadoccomment">     * @see #isIdle(IdleStatus)</em>
<a name="188" href="#188">188</a> <em class="jxr_javadoccomment">     */</em>
<a name="189" href="#189">189</a>     <strong class="jxr_keyword">boolean</strong> isWriterIdle();
<a name="190" href="#190">190</a>     
<a name="191" href="#191">191</a>     <em class="jxr_javadoccomment">/**</em>
<a name="192" href="#192">192</a> <em class="jxr_javadoccomment">     * Returns &lt;code&gt;true&lt;/code&gt; if this service is {@link IdleStatus#BOTH_IDLE}.</em>
<a name="193" href="#193">193</a> <em class="jxr_javadoccomment">     * @see #isIdle(IdleStatus)</em>
<a name="194" href="#194">194</a> <em class="jxr_javadoccomment">     */</em>
<a name="195" href="#195">195</a>     <strong class="jxr_keyword">boolean</strong> isBothIdle();
<a name="196" href="#196">196</a> 
<a name="197" href="#197">197</a>     <em class="jxr_javadoccomment">/**</em>
<a name="198" href="#198">198</a> <em class="jxr_javadoccomment">     * Returns the number of the fired continuous &lt;tt&gt;serviceIdle&lt;/tt&gt; events</em>
<a name="199" href="#199">199</a> <em class="jxr_javadoccomment">     * for the specified {@link IdleStatus}.</em>
<a name="200" href="#200">200</a> <em class="jxr_javadoccomment">     * &lt;p/&gt;</em>
<a name="201" href="#201">201</a> <em class="jxr_javadoccomment">     * If &lt;tt&gt;serviceIdle&lt;/tt&gt; event is fired first after some time after I/O,</em>
<a name="202" href="#202">202</a> <em class="jxr_javadoccomment">     * &lt;tt&gt;idleCount&lt;/tt&gt; becomes &lt;tt&gt;1&lt;/tt&gt;.  &lt;tt&gt;idleCount&lt;/tt&gt; resets to</em>
<a name="203" href="#203">203</a> <em class="jxr_javadoccomment">     * &lt;tt&gt;0&lt;/tt&gt; if any I/O occurs again, otherwise it increases to</em>
<a name="204" href="#204">204</a> <em class="jxr_javadoccomment">     * &lt;tt&gt;2&lt;/tt&gt; and so on if &lt;tt&gt;serviceIdle&lt;/tt&gt; event is fired again without</em>
<a name="205" href="#205">205</a> <em class="jxr_javadoccomment">     * any I/O between two (or more) &lt;tt&gt;serviceIdle&lt;/tt&gt; events.</em>
<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">     */</em>
<a name="207" href="#207">207</a>     <strong class="jxr_keyword">int</strong> getIdleCount(<a href="../../../../org/apache/mina/common/IdleStatus.html">IdleStatus</a> status);
<a name="208" href="#208">208</a> 
<a name="209" href="#209">209</a>     <em class="jxr_javadoccomment">/**</em>
<a name="210" href="#210">210</a> <em class="jxr_javadoccomment">     * Returns the number of the fired continuous &lt;tt&gt;serviceIdle&lt;/tt&gt; events</em>
<a name="211" href="#211">211</a> <em class="jxr_javadoccomment">     * for {@link IdleStatus#READER_IDLE}.</em>
<a name="212" href="#212">212</a> <em class="jxr_javadoccomment">     * @see #getIdleCount(IdleStatus)</em>
<a name="213" href="#213">213</a> <em class="jxr_javadoccomment">     */</em>
<a name="214" href="#214">214</a>     <strong class="jxr_keyword">int</strong> getReaderIdleCount();
<a name="215" href="#215">215</a> 
<a name="216" href="#216">216</a>     <em class="jxr_javadoccomment">/**</em>
<a name="217" href="#217">217</a> <em class="jxr_javadoccomment">     * Returns the number of the fired continuous &lt;tt&gt;serviceIdle&lt;/tt&gt; events</em>
<a name="218" href="#218">218</a> <em class="jxr_javadoccomment">     * for {@link IdleStatus#WRITER_IDLE}.</em>
<a name="219" href="#219">219</a> <em class="jxr_javadoccomment">     * @see #getIdleCount(IdleStatus)</em>
<a name="220" href="#220">220</a> <em class="jxr_javadoccomment">     */</em>
<a name="221" href="#221">221</a>     <strong class="jxr_keyword">int</strong> getWriterIdleCount();
<a name="222" href="#222">222</a>     
<a name="223" href="#223">223</a>     <em class="jxr_javadoccomment">/**</em>
<a name="224" href="#224">224</a> <em class="jxr_javadoccomment">     * Returns the number of the fired continuous &lt;tt&gt;serviceIdle&lt;/tt&gt; events</em>
<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">     * for {@link IdleStatus#BOTH_IDLE}.</em>
<a name="226" href="#226">226</a> <em class="jxr_javadoccomment">     * @see #getIdleCount(IdleStatus)</em>
<a name="227" href="#227">227</a> <em class="jxr_javadoccomment">     */</em>
<a name="228" href="#228">228</a>     <strong class="jxr_keyword">int</strong> getBothIdleCount();
<a name="229" href="#229">229</a>     
<a name="230" href="#230">230</a>     <em class="jxr_javadoccomment">/**</em>
<a name="231" href="#231">231</a> <em class="jxr_javadoccomment">     * Returns the time in milliseconds when the last &lt;tt&gt;serviceIdle&lt;/tt&gt; event</em>
<a name="232" href="#232">232</a> <em class="jxr_javadoccomment">     * is fired for the specified {@link IdleStatus}.</em>
<a name="233" href="#233">233</a> <em class="jxr_javadoccomment">     */</em>
<a name="234" href="#234">234</a>     <strong class="jxr_keyword">long</strong> getLastIdleTime(<a href="../../../../org/apache/mina/common/IdleStatus.html">IdleStatus</a> status);
<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">     * Returns the time in milliseconds when the last &lt;tt&gt;serviceIdle&lt;/tt&gt; event</em>
<a name="238" href="#238">238</a> <em class="jxr_javadoccomment">     * is fired for {@link IdleStatus#READER_IDLE}.</em>
<a name="239" href="#239">239</a> <em class="jxr_javadoccomment">     * @see #getLastIdleTime(IdleStatus)</em>
<a name="240" href="#240">240</a> <em class="jxr_javadoccomment">     */</em>
<a name="241" href="#241">241</a>     <strong class="jxr_keyword">long</strong> getLastReaderIdleTime();
<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">     * Returns the time in milliseconds when the last &lt;tt&gt;serviceIdle&lt;/tt&gt; event</em>
<a name="245" href="#245">245</a> <em class="jxr_javadoccomment">     * is fired for {@link IdleStatus#WRITER_IDLE}.</em>
<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">     * @see #getLastIdleTime(IdleStatus)</em>
<a name="247" href="#247">247</a> <em class="jxr_javadoccomment">     */</em>
<a name="248" href="#248">248</a>     <strong class="jxr_keyword">long</strong> getLastWriterIdleTime();
<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">     * Returns the time in milliseconds when the last &lt;tt&gt;serviceIdle&lt;/tt&gt; event</em>
<a name="252" href="#252">252</a> <em class="jxr_javadoccomment">     * is fired for {@link IdleStatus#BOTH_IDLE}.</em>
<a name="253" href="#253">253</a> <em class="jxr_javadoccomment">     * @see #getLastIdleTime(IdleStatus)</em>
<a name="254" href="#254">254</a> <em class="jxr_javadoccomment">     */</em>
<a name="255" href="#255">255</a>     <strong class="jxr_keyword">long</strong> getLastBothIdleTime();
<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">     * Returns idle time for the specified type of idleness in seconds.</em>
<a name="259" href="#259">259</a> <em class="jxr_javadoccomment">     */</em>
<a name="260" href="#260">260</a>     <strong class="jxr_keyword">int</strong> getIdleTime(<a href="../../../../org/apache/mina/common/IdleStatus.html">IdleStatus</a> status);
<a name="261" href="#261">261</a>     
<a name="262" href="#262">262</a>     <em class="jxr_javadoccomment">/**</em>
<a name="263" href="#263">263</a> <em class="jxr_javadoccomment">     * Returns idle time for the specified type of idleness in milliseconds.</em>
<a name="264" href="#264">264</a> <em class="jxr_javadoccomment">     */</em>
<a name="265" href="#265">265</a>     <strong class="jxr_keyword">long</strong> getIdleTimeInMillis(<a href="../../../../org/apache/mina/common/IdleStatus.html">IdleStatus</a> status);
<a name="266" href="#266">266</a> 
<a name="267" href="#267">267</a>     <em class="jxr_javadoccomment">/**</em>
<a name="268" href="#268">268</a> <em class="jxr_javadoccomment">     * Sets idle time for the specified type of idleness in seconds.</em>
<a name="269" href="#269">269</a> <em class="jxr_javadoccomment">     */</em>
<a name="270" href="#270">270</a>     <strong class="jxr_keyword">void</strong> setIdleTime(<a href="../../../../org/apache/mina/common/IdleStatus.html">IdleStatus</a> status, <strong class="jxr_keyword">int</strong> idleTime);
<a name="271" href="#271">271</a>     
<a name="272" href="#272">272</a>     <em class="jxr_javadoccomment">/**</em>
<a name="273" href="#273">273</a> <em class="jxr_javadoccomment">     * Returns idle time for {@link IdleStatus#READER_IDLE} in seconds.</em>
<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">     */</em>
<a name="275" href="#275">275</a>     <strong class="jxr_keyword">int</strong> getReaderIdleTime();
<a name="276" href="#276">276</a>     
<a name="277" href="#277">277</a>     <em class="jxr_javadoccomment">/**</em>
<a name="278" href="#278">278</a> <em class="jxr_javadoccomment">     * Returns idle time for {@link IdleStatus#READER_IDLE} in milliseconds.</em>
<a name="279" href="#279">279</a> <em class="jxr_javadoccomment">     */</em>
<a name="280" href="#280">280</a>     <strong class="jxr_keyword">long</strong> getReaderIdleTimeInMillis();
<a name="281" href="#281">281</a>     
<a name="282" href="#282">282</a>     <em class="jxr_javadoccomment">/**</em>
<a name="283" href="#283">283</a> <em class="jxr_javadoccomment">     * Sets idle time for {@link IdleStatus#READER_IDLE} in seconds.</em>
<a name="284" href="#284">284</a> <em class="jxr_javadoccomment">     */</em>
<a name="285" href="#285">285</a>     <strong class="jxr_keyword">void</strong> setReaderIdleTime(<strong class="jxr_keyword">int</strong> idleTime);
<a name="286" href="#286">286</a>     
<a name="287" href="#287">287</a>     <em class="jxr_javadoccomment">/**</em>
<a name="288" href="#288">288</a> <em class="jxr_javadoccomment">     * Returns idle time for {@link IdleStatus#WRITER_IDLE} in seconds.</em>
<a name="289" href="#289">289</a> <em class="jxr_javadoccomment">     */</em>
<a name="290" href="#290">290</a>     <strong class="jxr_keyword">int</strong> getWriterIdleTime();
<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 idle time for {@link IdleStatus#WRITER_IDLE} in milliseconds.</em>
<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">     */</em>