| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!--NewPage--> | |
| <HTML> | |
| <HEAD> | |
| <!-- Generated by javadoc (build 1.5.0_04) on Fri Oct 21 16:15:21 KST 2005 --> | |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | |
| <TITLE> | |
| ProtocolSession (MINA 0.8.0 API) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.mina.protocol.ProtocolSession interface"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="ProtocolSession (MINA 0.8.0 API)"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <A NAME="navbar_top"><!-- --></A> | |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_top_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ProtocolSession.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../org/apache/mina/protocol/ProtocolProvider.html" title="interface in org.apache.mina.protocol"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/mina/protocol/ProtocolSessionFilterChain.html" title="class in org.apache.mina.protocol"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/mina/protocol/ProtocolSession.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ProtocolSession.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_top"></A> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <HR> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <H2> | |
| <FONT SIZE="-1"> | |
| org.apache.mina.protocol</FONT> | |
| <BR> | |
| Interface ProtocolSession</H2> | |
| <DL> | |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</A></DD> | |
| </DL> | |
| <DL> | |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/mina/protocol/io/IoProtocolSession.html" title="class in org.apache.mina.protocol.io">IoProtocolSession</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public interface <B>ProtocolSession</B><DT>extends <A HREF="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</A></DL> | |
| </PRE> | |
| <P> | |
| A <A HREF="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common"><CODE>Session</CODE></A> which represents high-level protocol connection between two | |
| endpoints regardless of underlying transport types. | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Rev: 327113 $, $Date: 2005-10-21 15:59:15 +0900 $</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD>The Apache Directory Project (dev@directory.apache.org)</DD> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common"><CODE>Session</CODE></A></DL> | |
| <HR> | |
| <P> | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <A NAME="method_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Method Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol">ProtocolDecoder</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/mina/protocol/ProtocolSession.html#getDecoder()">getDecoder</A></B>()</CODE> | |
| <BR> | |
| Returns the <A HREF="../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolDecoder</CODE></A> for this session.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol">ProtocolEncoder</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/mina/protocol/ProtocolSession.html#getEncoder()">getEncoder</A></B>()</CODE> | |
| <BR> | |
| Returns the <A HREF="../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolEncoder</CODE></A> for this session.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/mina/protocol/ProtocolFilterChain.html" title="interface in org.apache.mina.protocol">ProtocolFilterChain</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/mina/protocol/ProtocolSession.html#getFilterChain()">getFilterChain</A></B>()</CODE> | |
| <BR> | |
| Returns the filter chain that only affects this session.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol">ProtocolHandler</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/mina/protocol/ProtocolSession.html#getHandler()">getHandler</A></B>()</CODE> | |
| <BR> | |
| Returns the <A HREF="../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolHandler</CODE></A> which handles this session.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/mina/protocol/ProtocolSession.html#write(java.lang.Object)">write</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> message)</CODE> | |
| <BR> | |
| Writes the specified <code>message</code> to remote peer.</TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_org.apache.mina.common.Session"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from interface org.apache.mina.common.<A HREF="../../../../org/apache/mina/common/Session.html" title="interface in org.apache.mina.common">Session</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../org/apache/mina/common/Session.html#close()">close</A>, <A HREF="../../../../org/apache/mina/common/Session.html#close(boolean)">close</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getAttachment()">getAttachment</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getAttribute(java.lang.String)">getAttribute</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getAttributeKeys()">getAttributeKeys</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getConfig()">getConfig</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getCreationTime()">getCreationTime</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getIdleCount(org.apache.mina.common.IdleStatus)">getIdleCount</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getLastIdleTime(org.apache.mina.common.IdleStatus)">getLastIdleTime</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getLastIoTime()">getLastIoTime</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getLastReadTime()">getLastReadTime</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getLastWriteTime()">getLastWriteTime</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getLocalAddress()">getLocalAddress</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getReadBytes()">getReadBytes</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getRemoteAddress()">getRemoteAddress</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getScheduledWriteRequests()">getScheduledWriteRequests</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getTransportType()">getTransportType</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getWrittenBytes()">getWrittenBytes</A>, <A HREF="../../../../org/apache/mina/common/Session.html#getWrittenWriteRequests()">getWrittenWriteRequests</A>, <A HREF="../../../../org/apache/mina/common/Session.html#isConnected()">isConnected</A>, <A HREF="../../../../org/apache/mina/common/Session.html#isIdle(org.apache.mina.common.IdleStatus)">isIdle</A>, <A HREF="../../../../org/apache/mina/common/Session.html#removeAttribute(java.lang.String)">removeAttribute</A>, <A HREF="../../../../org/apache/mina/common/Session.html#setAttachment(java.lang.Object)">setAttachment</A>, <A HREF="../../../../org/apache/mina/common/Session.html#setAttribute(java.lang.String, java.lang.Object)">setAttribute</A></CODE></TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <A NAME="method_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Method Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="getHandler()"><!-- --></A><H3> | |
| getHandler</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol">ProtocolHandler</A> <B>getHandler</B>()</PRE> | |
| <DL> | |
| <DD>Returns the <A HREF="../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolHandler</CODE></A> which handles this session. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getFilterChain()"><!-- --></A><H3> | |
| getFilterChain</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/mina/protocol/ProtocolFilterChain.html" title="interface in org.apache.mina.protocol">ProtocolFilterChain</A> <B>getFilterChain</B>()</PRE> | |
| <DL> | |
| <DD>Returns the filter chain that only affects this session. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getEncoder()"><!-- --></A><H3> | |
| getEncoder</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol">ProtocolEncoder</A> <B>getEncoder</B>()</PRE> | |
| <DL> | |
| <DD>Returns the <A HREF="../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolEncoder</CODE></A> for this session. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDecoder()"><!-- --></A><H3> | |
| getDecoder</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol">ProtocolDecoder</A> <B>getDecoder</B>()</PRE> | |
| <DL> | |
| <DD>Returns the <A HREF="../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolDecoder</CODE></A> for this session. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="write(java.lang.Object)"><!-- --></A><H3> | |
| write</H3> | |
| <PRE> | |
| void <B>write</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> message)</PRE> | |
| <DL> | |
| <DD>Writes the specified <code>message</code> to remote peer. This operation | |
| is asynchronous; <A HREF="../../../../org/apache/mina/protocol/ProtocolHandler.html#messageSent(org.apache.mina.protocol.ProtocolSession, java.lang.Object)"><CODE>ProtocolHandler.messageSent(ProtocolSession, Object)</CODE></A> | |
| will be invoked when the message is actually sent to remote peer. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <HR> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <A NAME="navbar_bottom"><!-- --></A> | |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ProtocolSession.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../org/apache/mina/protocol/ProtocolProvider.html" title="interface in org.apache.mina.protocol"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/mina/protocol/ProtocolSessionFilterChain.html" title="class in org.apache.mina.protocol"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/mina/protocol/ProtocolSession.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ProtocolSession.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| Copyright © 2004-2005 . All Rights Reserved. | |
| </BODY> | |
| </HTML> |