abstractiosession.html

MINA+API 关于MINA的API

public final long <B>getId</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#getId()">IoSession</A></CODE></B></DD>
<DD>Returns a unique identifier of this session.  Every session has its own
 ID which is different from each other.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#getId()">getId</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getProcessor()"><!-- --></A><H3>
getProcessor</H3>
<PRE>
protected abstract <A HREF="../../../../org/apache/mina/common/IoProcessor.html" title="interface in org.apache.mina.common">IoProcessor</A> <B>getProcessor</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isConnected()"><!-- --></A><H3>
isConnected</H3>
<PRE>
public final boolean <B>isConnected</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#isConnected()">IoSession</A></CODE></B></DD>
<DD>Returns <code>true</code> if this session is connected with remote peer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#isConnected()">isConnected</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isClosing()"><!-- --></A><H3>
isClosing</H3>
<PRE>
public final boolean <B>isClosing</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#isClosing()">IoSession</A></CODE></B></DD>
<DD>Returns <code>true</tt> if and only if this session is being closed
 (but not disconnected yet) or is closed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#isClosing()">isClosing</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getCloseFuture()"><!-- --></A><H3>
getCloseFuture</H3>
<PRE>
public final <A HREF="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common">CloseFuture</A> <B>getCloseFuture</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#getCloseFuture()">IoSession</A></CODE></B></DD>
<DD>Returns the <A HREF="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common"><CODE>CloseFuture</CODE></A> of this session.  This method returns
 the same instance whenever user calls it.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#getCloseFuture()">getCloseFuture</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isScheduledForFlush()"><!-- --></A><H3>
isScheduledForFlush</H3>
<PRE>
protected final boolean <B>isScheduledForFlush</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setScheduledForFlush(boolean)"><!-- --></A><H3>
setScheduledForFlush</H3>
<PRE>
protected final boolean <B>setScheduledForFlush</B>(boolean&nbsp;flag)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="close(boolean)"><!-- --></A><H3>
close</H3>
<PRE>
public final <A HREF="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common">CloseFuture</A> <B>close</B>(boolean&nbsp;rightNow)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#close(boolean)">IoSession</A></CODE></B></DD>
<DD>Closes this session immediately or after all queued write requests
 are flushed.  This operation is asynchronous.  Wait for the returned
 <A HREF="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common"><CODE>CloseFuture</CODE></A> if you want to wait for the session actually closed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#close(boolean)">close</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>rightNow</CODE> - <code>true</code> to close this session immediately
                    (i.e. <A HREF="../../../../org/apache/mina/common/IoSession.html#close()"><CODE>IoSession.close()</CODE></A>).
                    <code>false</code> to close this session after all queued
                    write requests are flushed (i.e. <A HREF="../../../../org/apache/mina/common/IoSession.html#closeOnFlush()"><CODE>IoSession.closeOnFlush()</CODE></A>).</DL>
</DD>
</DL>
<HR>

<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public final <A HREF="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common">CloseFuture</A> <B>close</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#close()">IoSession</A></CODE></B></DD>
<DD>Closes this session immediately.  This operation is asynchronous.
 Wait for the returned <A HREF="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common"><CODE>CloseFuture</CODE></A> if you want to wait for
 the session actually closed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="closeOnFlush()"><!-- --></A><H3>
closeOnFlush</H3>
<PRE>
public final <A HREF="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common">CloseFuture</A> <B>closeOnFlush</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#closeOnFlush()">IoSession</A></CODE></B></DD>
<DD>Closes this session after all queued write requests are flushed.
 This operation is asynchronous.  Wait for the returned <A HREF="../../../../org/apache/mina/common/CloseFuture.html" title="interface in org.apache.mina.common"><CODE>CloseFuture</CODE></A>
 if you want to wait for the session actually closed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#closeOnFlush()">closeOnFlush</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="read()"><!-- --></A><H3>
read</H3>
<PRE>
public final <A HREF="../../../../org/apache/mina/common/ReadFuture.html" title="interface in org.apache.mina.common">ReadFuture</A> <B>read</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#read()">IoSession</A></CODE></B></DD>
<DD>Returns a <A HREF="../../../../org/apache/mina/common/ReadFuture.html" title="interface in org.apache.mina.common"><CODE>ReadFuture</CODE></A> which is notified when a new message is
 received, the connection is closed or an exception is caught.  This
 operation is especially useful when you implement a client application.
 However, please note that this operation is disabled by default and
 throw <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"><CODE>IllegalStateException</CODE></A> because all received events must be
 queued somewhere to support this operation, possibly leading to memory
 leak.  This means you have to keep calling <A HREF="../../../../org/apache/mina/common/IoSession.html#read()"><CODE>IoSession.read()</CODE></A> once you
 enabled this operation.  To enable this operation, please call
 <A HREF="../../../../org/apache/mina/common/IoSessionConfig.html#setUseReadOperation(boolean)"><CODE>IoSessionConfig.setUseReadOperation(boolean)</CODE></A> with <tt>true</tt>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/mina/common/IoSession.html#read()">read</A></CODE> in interface <CODE><A HREF="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="offerReadFuture(java.lang.Object)"><!-- --></A><H3>
offerReadFuture</H3>
<PRE>
protected final void <B>offerReadFuture</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;message)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="offerFailedReadFuture(java.lang.Throwable)"><!-- --></A><H3>
offerFailedReadFuture</H3>
<PRE>
protected final void <B>offerFailedReadFuture</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</A>&nbsp;exception)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="off