ioservice.html

MINA+API 关于MINA的API

<DD><DL>

<DT><B>Returns:</B><DD>the sessions. An empty collection if there's no session.</DL>
</DD>
</DL>
<HR>

<A NAME="getManagedSessionCount()"><!-- --></A><H3>
getManagedSessionCount</H3>
<PRE>
int <B>getManagedSessionCount</B>()</PRE>
<DL>
<DD>Returns the number of all sessions which are currently managed by this
 service.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getLargestManagedSessionCount()"><!-- --></A><H3>
getLargestManagedSessionCount</H3>
<PRE>
int <B>getLargestManagedSessionCount</B>()</PRE>
<DL>
<DD>Returns the maximum number of sessions which were being managed at the
 same time.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getCumulativeManagedSessionCount()"><!-- --></A><H3>
getCumulativeManagedSessionCount</H3>
<PRE>
long <B>getCumulativeManagedSessionCount</B>()</PRE>
<DL>
<DD>Returns the cumulative number of sessions which were managed (or are
 being managed) by this service, which means 'currently managed session
 count + closed session count'.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getSessionConfig()"><!-- --></A><H3>
getSessionConfig</H3>
<PRE>
<A HREF="../../../../org/apache/mina/common/IoSessionConfig.html" title="interface in org.apache.mina.common">IoSessionConfig</A> <B>getSessionConfig</B>()</PRE>
<DL>
<DD>Returns the default configuration of the new <A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><CODE>IoSession</CODE></A>s
 created by this service.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getFilterChainBuilder()"><!-- --></A><H3>
getFilterChainBuilder</H3>
<PRE>
<A HREF="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common">IoFilterChainBuilder</A> <B>getFilterChainBuilder</B>()</PRE>
<DL>
<DD>Returns the <A HREF="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common"><CODE>IoFilterChainBuilder</CODE></A> which will build the
 <A HREF="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common"><CODE>IoFilterChain</CODE></A> of all <A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><CODE>IoSession</CODE></A>s which is created
 by this service.
 The default value is an empty <A HREF="../../../../org/apache/mina/common/DefaultIoFilterChainBuilder.html" title="class in org.apache.mina.common"><CODE>DefaultIoFilterChainBuilder</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setFilterChainBuilder(org.apache.mina.common.IoFilterChainBuilder)"><!-- --></A><H3>
setFilterChainBuilder</H3>
<PRE>
void <B>setFilterChainBuilder</B>(<A HREF="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common">IoFilterChainBuilder</A>&nbsp;builder)</PRE>
<DL>
<DD>Sets the <A HREF="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common"><CODE>IoFilterChainBuilder</CODE></A> which will build the
 <A HREF="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common"><CODE>IoFilterChain</CODE></A> of all <A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><CODE>IoSession</CODE></A>s which is created
 by this service.
 If you specify <tt>null</tt> this property will be set to
 an empty <A HREF="../../../../org/apache/mina/common/DefaultIoFilterChainBuilder.html" title="class in org.apache.mina.common"><CODE>DefaultIoFilterChainBuilder</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getFilterChain()"><!-- --></A><H3>
getFilterChain</H3>
<PRE>
<A HREF="../../../../org/apache/mina/common/DefaultIoFilterChainBuilder.html" title="class in org.apache.mina.common">DefaultIoFilterChainBuilder</A> <B>getFilterChain</B>()</PRE>
<DL>
<DD>A shortcut for <tt>( ( DefaultIoFilterChainBuilder ) </tt><A HREF="../../../../org/apache/mina/common/IoService.html#getFilterChainBuilder()"><CODE>getFilterChainBuilder()</CODE></A><tt> )</tt>.
 Please note that the returned object is not a <b>real</b> <A HREF="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common"><CODE>IoFilterChain</CODE></A>
 but a <A HREF="../../../../org/apache/mina/common/DefaultIoFilterChainBuilder.html" title="class in org.apache.mina.common"><CODE>DefaultIoFilterChainBuilder</CODE></A>.  Modifying the returned builder
 won't affect the existing <A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><CODE>IoSession</CODE></A>s at all, because
 <A HREF="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common"><CODE>IoFilterChainBuilder</CODE></A>s affect only newly created <A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common"><CODE>IoSession</CODE></A>s.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the current <A HREF="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common"><CODE>IoFilterChainBuilder</CODE></A> is
                               not a <A HREF="../../../../org/apache/mina/common/DefaultIoFilterChainBuilder.html" title="class in org.apache.mina.common"><CODE>DefaultIoFilterChainBuilder</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="isActive()"><!-- --></A><H3>
isActive</H3>
<PRE>
boolean <B>isActive</B>()</PRE>
<DL>
<DD>Returns a value of whether or not this service is active
<P>
<DD><DL>

<DT><B>Returns:</B><DD>whether of not the service is active.</DL>
</DD>
</DL>
<HR>

<A NAME="getActivationTime()"><!-- --></A><H3>
getActivationTime</H3>
<PRE>
long <B>getActivationTime</B>()</PRE>
<DL>
<DD>Returns the time when this service was activated.  It returns the last
 time when this service was activated if the service is not active now.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The time by using <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/System.html?is-external=true#currentTimeMillis()" title="class or interface in java.lang"><CODE>System.currentTimeMillis()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getLastIoTime()"><!-- --></A><H3>
getLastIoTime</H3>
<PRE>
long <B>getLastIoTime</B>()</PRE>
<DL>
<DD>Returns the time in millis when I/O occurred lastly.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getLastReadTime()"><!-- --></A><H3>
getLastReadTime</H3>
<PRE>
long <B>getLastReadTime</B>()</PRE>
<DL>
<DD>Returns the time in millis when read operation occurred lastly.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getLastWriteTime()"><!-- --></A><H3>
getLastWriteTime</H3>
<PRE>
long <B>getLastWriteTime</B>()</PRE>
<DL>
<DD>Returns the time in millis when write operation occurred lastly.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isIdle(org.apache.mina.common.IdleStatus)"><!-- --></A><H3>
isIdle</H3>
<PRE>
boolean <B>isIdle</B>(<A HREF="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</A>&nbsp;status)</PRE>
<DL>
<DD>Returns <code>true</code> if this service is idle for the specified
 <A HREF="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common"><CODE>IdleStatus</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isReaderIdle()"><!-- --></A><H3>
isReaderIdle</H3>
<PRE>
boolean <B>isReaderIdle</B>()</PRE>
<DL>
<DD>Returns <code>true</code> if this service is <A HREF="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><CODE>IdleStatus.READER_IDLE</CODE></A>.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/mina/common/IoService.html#isIdle(org.apache.mina.common.IdleStatus)"><CODE>isIdle(IdleStatus)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="isWriterIdle()"><!-- --></A><H3>
isWriterIdle</H3>
<PRE>
boolean <B>isWriterIdle</B>()</PRE>
<DL>
<DD>Returns <code>true</code> if this service is <A HREF="../../../../org/apache/mina/common/IdleStatus.html#WRITER_IDLE"><CODE>IdleStatus.WRITER_IDLE</CODE></A>.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/mina/common/IoService.html#isIdle(org.apache.mina.common.IdleStatus)"><CODE>isIdle(IdleStatus)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="isBothIdle()"><!-- --></A><H3>
isBothIdle</H3>
<PRE>
boolean <B>isBothIdle</B>()</PRE>
<DL>
<DD>Returns <code>true</code> if this service is <A HREF="../../../../org/apache/mina/common/IdleStatus.html#BOTH_IDLE"><CODE>IdleStatus.BOTH_IDLE</CODE></A>.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/mina/common/IoService.html#isIdle(org.apache.mina.common.IdleStatus)"><CODE>isIdle(IdleStatus)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getIdleCount(org.apache.mina.common.IdleStatus)"><!-- --></A><H3>
getIdleCount</H3>
<PRE>
int <B>getIdleCount</B>(<A HREF="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common">IdleStatus</A>&nbsp;status)</PRE>
<DL>
<DD>Returns the number of the fired continuous <tt>serviceIdle</tt> events
 for the specified <A HREF="../../../../org/apache/mina/common/IdleStatus.html" title="class in org.apache.mina.common"><CODE>IdleStatus</CODE></A>.
 <p/>
 If <tt>serviceIdle</tt> event is fired first after some time after I/O,
 <tt>idleCount</tt> becomes <tt>1</tt>.  <tt>idleCount</tt> resets to
 <tt>0</tt> if any I/O occurs again, otherwise it increases to
 <tt>2</tt> and so on if <tt>serviceIdle</tt> event is fired again without
 any I/O between two (or more) <tt>serviceIdle</tt> events.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getReaderIdleCount()"><!-- --></A><H3>
getReaderIdleCount</H3>
<PRE>
int <B>getReaderIdleCount</B>()</PRE>
<DL>
<DD>Returns the number of the fired continuous <tt>serviceIdle</tt> events
 for <A HREF="../../../../org/apache/mina/common/IdleStatus.html#READER_IDLE"><CODE>IdleStatus.READER_IDLE</CODE></A>.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/mina/common/IoService.html#getIdleCount(org.apache.mina.common.IdleStatus)"><CODE>getIdleCount(IdleStatus)</CODE></A></DL>
</DD>