messagedecoder.html

MINA+API 关于MINA的API

</TR>
</TABLE>
&nbsp;
<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.common.IoSession, org.apache.mina.common.IoBuffer)"><CODE>decodable(IoSession, IoBuffer)</CODE></A> and
 <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode(org.apache.mina.common.IoSession, org.apache.mina.common.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.common.IoSession, org.apache.mina.common.IoBuffer)"><CODE>decodable(IoSession, IoBuffer)</CODE></A> and
 <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode(org.apache.mina.common.IoSession, org.apache.mina.common.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.common.IoSession, org.apache.mina.common.IoBuffer)"><CODE>decodable(IoSession, IoBuffer)</CODE></A> and
 <A HREF="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode(org.apache.mina.common.IoSession, org.apache.mina.common.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.common.IoSession, org.apache.mina.common.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/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A>&nbsp;session,
                               <A HREF="../../../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common">IoBuffer</A>&nbsp;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.common.IoSession, org.apache.mina.common.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/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A>&nbsp;session,
                            <A HREF="../../../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common">IoBuffer</A>&nbsp;in,
                            <A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoderOutput</A>&nbsp;out)
                            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>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.common.IoSession, org.apache.mina.common.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://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> - if the read data violated protocol specification</DL>
</DD>
</DL>
<HR>

<A NAME="finishDecode(org.apache.mina.common.IoSession, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><!-- --></A><H3>
finishDecode</H3>
<PRE>
void <B>finishDecode</B>(<A HREF="../../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A>&nbsp;session,
                  <A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoderOutput</A>&nbsp;out)
                  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>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.common.IoSession, org.apache.mina.common.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://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> - 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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MessageDecoder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolEncoder.html" title="class in org.apache.mina.filter.codec.demux"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<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>  &nbsp;
&nbsp;<A HREF="MessageDecoder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright 漏 2004-2008 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.
</BODY>
</HTML>