| <!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.6.0_33) on Tue Aug 21 16:43:16 CEST 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| MessageDecoder (Apache MINA 2.0.5 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2012-08-21"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MessageDecoder (Apache MINA 2.0.5 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= 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/MessageDecoder.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/filter/codec/demux/DemuxingProtocolEncoder.html" title="class in org.apache.mina.filter.codec.demux"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderAdapter.html" title="class in org.apache.mina.filter.codec.demux"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/mina/filter/codec/demux/MessageDecoder.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="MessageDecoder.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | 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.filter.codec.demux</FONT> |
| <BR> |
| Interface MessageDecoder</H2> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../org/apache/mina/example/sumup/codec/AbstractMessageDecoder.html" title="class in org.apache.mina.example.sumup.codec">AbstractMessageDecoder</A>, <A HREF="../../../../../../org/apache/mina/example/sumup/codec/AddMessageDecoder.html" title="class in org.apache.mina.example.sumup.codec">AddMessageDecoder</A>, <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderAdapter.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderAdapter</A>, <A HREF="../../../../../../org/apache/mina/example/sumup/codec/ResultMessageDecoder.html" title="class in org.apache.mina.example.sumup.codec">ResultMessageDecoder</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>MessageDecoder</B></DL> |
| </PRE> |
| |
| <P> |
| Decodes a certain type of messages. |
| <p> |
| We didn't provide any <tt>dispose</tt> method for <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux"><CODE>MessageDecoder</CODE></A> |
| because it can give you performance penalty in case you have a lot of |
| message types to handle. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD><a href="http://mina.apache.org">Apache MINA Project</a></DD> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html" title="class in org.apache.mina.filter.codec.demux"><CODE>DemuxingProtocolDecoder</CODE></A>, |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderFactory.html" title="interface in org.apache.mina.filter.codec.demux"><CODE>MessageDecoderFactory</CODE></A></DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_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>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NEED_DATA">NEED_DATA</A></B></CODE> |
| |
| <BR> |
| Represents a result from <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer)"><CODE>decodable(IoSession, IoBuffer)</CODE></A> and |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><CODE>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NOT_OK">NOT_OK</A></B></CODE> |
| |
| <BR> |
| Represents a result from <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer)"><CODE>decodable(IoSession, IoBuffer)</CODE></A> and |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><CODE>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#OK">OK</A></B></CODE> |
| |
| <BR> |
| Represents a result from <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer)"><CODE>decodable(IoSession, IoBuffer)</CODE></A> and |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><CODE>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</CODE></A>.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer)">decodable</A></B>(<A HREF="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</A> session, |
| <A HREF="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</A> in)</CODE> |
| |
| <BR> |
| Checks the specified buffer is decodable by this decoder.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)">decode</A></B>(<A HREF="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</A> session, |
| <A HREF="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</A> in, |
| <A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoderOutput</A> out)</CODE> |
| |
| <BR> |
| Decodes binary or protocol-specific content into higher-level message objects.</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/filter/codec/demux/MessageDecoder.html#finishDecode(org.apache.mina.core.session.IoSession, org.apache.mina.filter.codec.ProtocolDecoderOutput)">finishDecode</A></B>(<A HREF="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</A> session, |
| <A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoderOutput</A> out)</CODE> |
| |
| <BR> |
| Invoked when the specified <tt>session</tt> is closed while this decoder was |
| parsing the data.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_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>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="OK"><!-- --></A><H3> |
| OK</H3> |
| <PRE> |
| static final <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</A> <B>OK</B></PRE> |
| <DL> |
| <DD>Represents a result from <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer)"><CODE>decodable(IoSession, IoBuffer)</CODE></A> and |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><CODE>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</CODE></A>. Please |
| refer to each method's documentation for detailed explanation. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="NEED_DATA"><!-- --></A><H3> |
| NEED_DATA</H3> |
| <PRE> |
| static final <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</A> <B>NEED_DATA</B></PRE> |
| <DL> |
| <DD>Represents a result from <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer)"><CODE>decodable(IoSession, IoBuffer)</CODE></A> and |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><CODE>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</CODE></A>. Please |
| refer to each method's documentation for detailed explanation. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="NOT_OK"><!-- --></A><H3> |
| NOT_OK</H3> |
| <PRE> |
| static final <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</A> <B>NOT_OK</B></PRE> |
| <DL> |
| <DD>Represents a result from <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer)"><CODE>decodable(IoSession, IoBuffer)</CODE></A> and |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><CODE>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</CODE></A>. Please |
| refer to each method's documentation for detailed explanation. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ============ 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="decodable(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer)"><!-- --></A><H3> |
| decodable</H3> |
| <PRE> |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</A> <B>decodable</B>(<A HREF="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</A> session, |
| <A HREF="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</A> in)</PRE> |
| <DL> |
| <DD>Checks the specified buffer is decodable by this decoder. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#OK"><CODE>OK</CODE></A> if this decoder can decode the specified buffer. |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NOT_OK"><CODE>NOT_OK</CODE></A> if this decoder cannot decode the specified buffer. |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NEED_DATA"><CODE>NEED_DATA</CODE></A> if more data is required to determine if the |
| specified buffer is decodable (<A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#OK"><CODE>OK</CODE></A>) or not decodable |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NOT_OK"><CODE>NOT_OK</CODE></A>.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><!-- --></A><H3> |
| decode</H3> |
| <PRE> |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</A> <B>decode</B>(<A HREF="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</A> session, |
| <A HREF="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</A> in, |
| <A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoderOutput</A> out) |
| throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Decodes binary or protocol-specific content into higher-level message objects. |
| MINA invokes <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><CODE>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</CODE></A> |
| method with read data, and then the decoder implementation puts decoded |
| messages into <A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html" title="interface in org.apache.mina.filter.codec"><CODE>ProtocolDecoderOutput</CODE></A>. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#OK"><CODE>OK</CODE></A> if you finished decoding messages successfully. |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NEED_DATA"><CODE>NEED_DATA</CODE></A> if you need more data to finish decoding current message. |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NOT_OK"><CODE>NOT_OK</CODE></A> if you cannot decode current message due to protocol specification violation. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - if the read data violated protocol specification</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="finishDecode(org.apache.mina.core.session.IoSession, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><!-- --></A><H3> |
| finishDecode</H3> |
| <PRE> |
| void <B>finishDecode</B>(<A HREF="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</A> session, |
| <A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoderOutput</A> out) |
| throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD>Invoked when the specified <tt>session</tt> is closed while this decoder was |
| parsing the data. This method is useful when you deal with the protocol which doesn't |
| specify the length of a message such as HTTP response without <tt>content-length</tt> |
| header. Implement this method to process the remaining data that |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><CODE>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</CODE></A> method didn't process |
| completely. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - if the read data violated protocol specification</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/MessageDecoder.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/filter/codec/demux/DemuxingProtocolEncoder.html" title="class in org.apache.mina.filter.codec.demux"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderAdapter.html" title="class in org.apache.mina.filter.codec.demux"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/apache/mina/filter/codec/demux/MessageDecoder.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="MessageDecoder.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2004-2012 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
