abstractioservice.html

MINA+API 关于MINA的API

<A NAME="getFilterChainBuilder()"><!-- --></A><H3>
getFilterChainBuilder</H3>
<PRE>
public final <A HREF="../../../../org/apache/mina/common/IoFilterChainBuilder.html" title="interface in org.apache.mina.common">IoFilterChainBuilder</A> <B>getFilterChainBuilder</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoService.html#getFilterChainBuilder()">IoService</A></CODE></B></DD>
<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>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoService.html#getFilterChainBuilder()">getFilterChainBuilder</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setFilterChainBuilder(org.apache.mina.common.IoFilterChainBuilder)"><!-- --></A><H3>
setFilterChainBuilder</H3>
<PRE>
public final 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><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoService.html#setFilterChainBuilder(org.apache.mina.common.IoFilterChainBuilder)">IoService</A></CODE></B></DD>
<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>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoService.html#setFilterChainBuilder(org.apache.mina.common.IoFilterChainBuilder)">setFilterChainBuilder</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getFilterChain()"><!-- --></A><H3>
getFilterChain</H3>
<PRE>
public final <A HREF="../../../../org/apache/mina/common/DefaultIoFilterChainBuilder.html" title="class in org.apache.mina.common">DefaultIoFilterChainBuilder</A> <B>getFilterChain</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoService.html#getFilterChain()">IoService</A></CODE></B></DD>
<DD>A shortcut for <tt>( ( DefaultIoFilterChainBuilder ) </tt><A HREF="../../../../org/apache/mina/common/IoService.html#getFilterChainBuilder()"><CODE>IoService.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>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoService.html#getFilterChain()">getFilterChain</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="addListener(org.apache.mina.common.IoServiceListener)"><!-- --></A><H3>
addListener</H3>
<PRE>
public final void <B>addListener</B>(<A HREF="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common">IoServiceListener</A>&nbsp;listener)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoService.html#addListener(org.apache.mina.common.IoServiceListener)">IoService</A></CODE></B></DD>
<DD>Adds an <A HREF="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common"><CODE>IoServiceListener</CODE></A> that listens any events related with
 this service.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoService.html#addListener(org.apache.mina.common.IoServiceListener)">addListener</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="removeListener(org.apache.mina.common.IoServiceListener)"><!-- --></A><H3>
removeListener</H3>
<PRE>
public final void <B>removeListener</B>(<A HREF="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common">IoServiceListener</A>&nbsp;listener)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoService.html#removeListener(org.apache.mina.common.IoServiceListener)">IoService</A></CODE></B></DD>
<DD>Removed an existing <A HREF="../../../../org/apache/mina/common/IoServiceListener.html" title="interface in org.apache.mina.common"><CODE>IoServiceListener</CODE></A> that listens any events
 related with this service.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoService.html#removeListener(org.apache.mina.common.IoServiceListener)">removeListener</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isActive()"><!-- --></A><H3>
isActive</H3>
<PRE>
public final boolean <B>isActive</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoService.html#isActive()">IoService</A></CODE></B></DD>
<DD>Returns a value of whether or not this service is active
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoService.html#isActive()">isActive</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</A></CODE></DL>
</DD>
<DD><DL>

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

<A NAME="isDisposing()"><!-- --></A><H3>
isDisposing</H3>
<PRE>
public final boolean <B>isDisposing</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoService.html#isDisposing()">IoService</A></CODE></B></DD>
<DD>Returns <tt>true</tt> if and if only <A HREF="../../../../org/apache/mina/common/IoService.html#dispose()"><CODE>IoService.dispose()</CODE></A> method has
 been called.  Please note that this method will return <tt>true</tt>
 even after all the related resources are released.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoService.html#isDisposing()">isDisposing</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isDisposed()"><!-- --></A><H3>
isDisposed</H3>
<PRE>
public final boolean <B>isDisposed</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoService.html#isDisposed()">IoService</A></CODE></B></DD>
<DD>Returns <tt>true</tt> if and if only all resources of this processor
 have been disposed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoService.html#isDisposed()">isDisposed</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="dispose()"><!-- --></A><H3>
dispose</H3>
<PRE>
public final void <B>dispose</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoService.html#dispose()">IoService</A></CODE></B></DD>
<DD>Releases any resources allocated by this service.  Please note that 
 this method might block as long as there are any sessions managed by
 this service.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoService.html#dispose()">dispose</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="dispose0()"><!-- --></A><H3>
dispose0</H3>
<PRE>
protected abstract <A HREF="../../../../org/apache/mina/common/IoFuture.html" title="interface in org.apache.mina.common">IoFuture</A> <B>dispose0</B>()
                              throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
<DL>
<DD>Implement this method to release any acquired resources.  This method
 is invoked only once by <A HREF="../../../../org/apache/mina/common/AbstractIoService.html#dispose()"><CODE>dispose()</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getManagedSessions()"><!-- --></A><H3>
getManagedSessions</H3>
<PRE>
public final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A>&lt;<A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A>&gt; <B>getManagedSessions</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoService.html#getManagedSessions()">IoService</A></CODE></B></DD>
<DD>Returns all sessions which are currently managed by this service.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoService.html#getManagedSessions()">getManagedSessions</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoService.html" title="interface in org.apache.mina.common">IoService</A></CODE></DL>
</DD>
<DD><DL>

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

<A NAME="getCumulativeManagedSessionCount()"><!-- --></A><H3>
getCumulativeManagedSessionCount</H3>
<PRE>
public final long <B>getCumulativeManagedSessionCount</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mi