| <!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_01) on Tue May 17 17:40:19 KST 2005 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| org.apache.mina.protocol (MINA 0.7.1 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.mina.protocol package"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="org.apache.mina.protocol (MINA 0.7.1 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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.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/io/socket/package-summary.html"><B>PREV PACKAGE</B></A> |
| <A HREF="../../../../org/apache/mina/protocol/codec/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/mina/protocol/package-summary.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="package-summary.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> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <H2> |
| Package org.apache.mina.protocol |
| </H2> |
| High-level protocol implementation layer (Protocol layer). |
| <P> |
| <B>See:</B> |
| <BR> |
| <A HREF="#package_description"><B>Description</B></A> |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Interface Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolAcceptor.html" title="interface in org.apache.mina.protocol">ProtocolAcceptor</A></B></TD> |
| <TD>Accepts incoming connection, communicates with clients, and fires events to |
| <A HREF="../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolHandler</CODE></A>s.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolCodecFactory.html" title="interface in org.apache.mina.protocol">ProtocolCodecFactory</A></B></TD> |
| <TD>Provides <A HREF="../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolEncoder</CODE></A> and <A HREF="../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolDecoder</CODE></A> which translates |
| binary or protocol specific data into message object and vice versa.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolConnector.html" title="interface in org.apache.mina.protocol">ProtocolConnector</A></B></TD> |
| <TD>Connects to endpoint, communicates with the server, and fires events to |
| <A HREF="../../../../org/apache/mina/protocol/ProtocolProvider.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolProvider</CODE></A>s.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol">ProtocolDecoder</A></B></TD> |
| <TD>Decodes binary or protocol-specific data into higher-level message objects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolDecoderOutput.html" title="interface in org.apache.mina.protocol">ProtocolDecoderOutput</A></B></TD> |
| <TD>Callback for <A HREF="../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolDecoder</CODE></A> to generate decoded messages.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol">ProtocolEncoder</A></B></TD> |
| <TD>Encodes higher-level message objects into binary or protocol-specific data.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolEncoderOutput.html" title="interface in org.apache.mina.protocol">ProtocolEncoderOutput</A></B></TD> |
| <TD>Callback for <A HREF="../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolEncoder</CODE></A> to generate encoded <A HREF="../../../../org/apache/mina/common/ByteBuffer.html" title="class in org.apache.mina.common"><CODE>ByteBuffer</CODE></A>s.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolFilter.html" title="interface in org.apache.mina.protocol">ProtocolFilter</A></B></TD> |
| <TD>A filter which intercepts <A HREF="../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolHandler</CODE></A> events like Servlet |
| filters.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolFilter.NextFilter.html" title="interface in org.apache.mina.protocol">ProtocolFilter.NextFilter</A></B></TD> |
| <TD> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolFilterChain.html" title="interface in org.apache.mina.protocol">ProtocolFilterChain</A></B></TD> |
| <TD> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol">ProtocolHandler</A></B></TD> |
| <TD>Handles all protocol events fired by MINA.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolProvider.html" title="interface in org.apache.mina.protocol">ProtocolProvider</A></B></TD> |
| <TD>Provides a required information to implement high-level protocols.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</A></B></TD> |
| <TD>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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolSessionManager.html" title="interface in org.apache.mina.protocol">ProtocolSessionManager</A></B></TD> |
| <TD>A <A HREF="../../../../org/apache/mina/common/SessionManager.html" title="interface in org.apache.mina.common"><CODE>SessionManager</CODE></A> for Protocol layer.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Class Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/AbstractProtocolFilterChain.html" title="class in org.apache.mina.protocol">AbstractProtocolFilterChain</A></B></TD> |
| <TD>An abstract implementation of <A HREF="../../../../org/apache/mina/protocol/ProtocolFilterChain.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolFilterChain</CODE></A> that provides |
| common operations for developers to extend protocol layer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolFilterAdapter.html" title="class in org.apache.mina.protocol">ProtocolFilterAdapter</A></B></TD> |
| <TD>An abstract adapter class for <A HREF="../../../../org/apache/mina/protocol/ProtocolFilter.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolFilter</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolHandlerAdapter.html" title="class in org.apache.mina.protocol">ProtocolHandlerAdapter</A></B></TD> |
| <TD>An abstract adapter class for <A HREF="../../../../org/apache/mina/protocol/ProtocolHandler.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolHandler</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolSessionFilterChain.html" title="class in org.apache.mina.protocol">ProtocolSessionFilterChain</A></B></TD> |
| <TD>An <A HREF="../../../../org/apache/mina/io/IoFilterChain.html" title="interface in org.apache.mina.io"><CODE>IoFilterChain</CODE></A> that forwards <tt>filterWrite</tt> |
| requests to the specified <A HREF="../../../../org/apache/mina/io/IoSessionManagerFilterChain.html" title="class in org.apache.mina.io"><CODE>IoSessionManagerFilterChain</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolSessionManagerFilterChain.html" title="class in org.apache.mina.protocol">ProtocolSessionManagerFilterChain</A></B></TD> |
| <TD>An <A HREF="../../../../org/apache/mina/protocol/ProtocolFilterChain.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolFilterChain</CODE></A> that forwards all events |
| except <tt>filterWrite</tt> to the <A HREF="../../../../org/apache/mina/protocol/ProtocolSessionFilterChain.html" title="class in org.apache.mina.protocol"><CODE>ProtocolSessionFilterChain</CODE></A> |
| of the recipient session.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/SimpleProtocolDecoderOutput.html" title="class in org.apache.mina.protocol">SimpleProtocolDecoderOutput</A></B></TD> |
| <TD>A <A HREF="../../../../org/apache/mina/protocol/ProtocolDecoderOutput.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolDecoderOutput</CODE></A> based on queue.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/SimpleProtocolEncoderOutput.html" title="class in org.apache.mina.protocol">SimpleProtocolEncoderOutput</A></B></TD> |
| <TD>A <A HREF="../../../../org/apache/mina/protocol/ProtocolEncoderOutput.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolEncoderOutput</CODE></A> based on queue.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Exception Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/apache/mina/protocol/ProtocolViolationException.html" title="class in org.apache.mina.protocol">ProtocolViolationException</A></B></TD> |
| <TD>An exception that is thrown when <A HREF="../../../../org/apache/mina/protocol/ProtocolEncoder.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolEncoder</CODE></A> cannot understand or |
| failed to validate the specified message, or when <A HREF="../../../../org/apache/mina/protocol/ProtocolDecoder.html" title="interface in org.apache.mina.protocol"><CODE>ProtocolDecoder</CODE></A> |
| cannot understand or failed to validate the specified <A HREF="../../../../org/apache/mina/common/ByteBuffer.html" title="class in org.apache.mina.common"><CODE>ByteBuffer</CODE></A> |
| content.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| <A NAME="package_description"><!-- --></A><H2> |
| Package org.apache.mina.protocol Description |
| </H2> |
| |
| <P> |
| High-level protocol implementation layer (Protocol layer). |
| <P> |
| |
| <P> |
| <DL> |
| </DL> |
| <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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.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/io/socket/package-summary.html"><B>PREV PACKAGE</B></A> |
| <A HREF="../../../../org/apache/mina/protocol/codec/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/mina/protocol/package-summary.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="package-summary.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> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2005 . All Rights Reserved. |
| </BODY> |
| </HTML> |
