prefixedstringdecoder.html

MINA+API 关于MINA的API

<TH ALIGN="left"><B>Methods inherited from class org.apache.mina.filter.codec.<A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderAdapter.html" title="class in org.apache.mina.filter.codec">ProtocolDecoderAdapter</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderAdapter.html#finishDecode(org.apache.mina.common.IoSession, org.apache.mina.filter.codec.ProtocolDecoderOutput)">finishDecode</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<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></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</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="DEFAULT_PREFIX_LENGTH"><!-- --></A><H3>
DEFAULT_PREFIX_LENGTH</H3>
<PRE>
public static final int <B>DEFAULT_PREFIX_LENGTH</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.mina.filter.codec.prefixedstring.PrefixedStringDecoder.DEFAULT_PREFIX_LENGTH">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="DEFAULT_MAX_DATA_LENGTH"><!-- --></A><H3>
DEFAULT_MAX_DATA_LENGTH</H3>
<PRE>
public static final int <B>DEFAULT_MAX_DATA_LENGTH</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.mina.filter.codec.prefixedstring.PrefixedStringDecoder.DEFAULT_MAX_DATA_LENGTH">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="PrefixedStringDecoder(java.nio.charset.Charset, int, int)"><!-- --></A><H3>
PrefixedStringDecoder</H3>
<PRE>
public <B>PrefixedStringDecoder</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</A>&nbsp;charset,
                             int&nbsp;prefixLength,
                             int&nbsp;maxDataLength)</PRE>
<DL>
<DL>
<DT><B>Parameters:</B><DD><CODE>charset</CODE> - the charset to use for encoding<DD><CODE>prefixLength</CODE> - the length of the prefix<DD><CODE>maxDataLength</CODE> - maximum number of bytes allowed for a single String</DL>
</DL>
<HR>

<A NAME="PrefixedStringDecoder(java.nio.charset.Charset, int)"><!-- --></A><H3>
PrefixedStringDecoder</H3>
<PRE>
public <B>PrefixedStringDecoder</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</A>&nbsp;charset,
                             int&nbsp;prefixLength)</PRE>
<DL>
</DL>
<HR>

<A NAME="PrefixedStringDecoder(java.nio.charset.Charset)"><!-- --></A><H3>
PrefixedStringDecoder</H3>
<PRE>
public <B>PrefixedStringDecoder</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</A>&nbsp;charset)</PRE>
<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="setPrefixLength(int)"><!-- --></A><H3>
setPrefixLength</H3>
<PRE>
public void <B>setPrefixLength</B>(int&nbsp;prefixLength)</PRE>
<DL>
<DD>Sets the number of bytes used by the length prefix
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>prefixLength</CODE> - the length of the length prefix (1, 2, or 4)</DL>
</DD>
</DL>
<HR>

<A NAME="getPrefixLength()"><!-- --></A><H3>
getPrefixLength</H3>
<PRE>
public int <B>getPrefixLength</B>()</PRE>
<DL>
<DD>Gets the length of the length prefix (1, 2, or 4)
<P>
<DD><DL>

<DT><B>Returns:</B><DD>length of the length prefix</DL>
</DD>
</DL>
<HR>

<A NAME="setMaxDataLength(int)"><!-- --></A><H3>
setMaxDataLength</H3>
<PRE>
public void <B>setMaxDataLength</B>(int&nbsp;maxDataLength)</PRE>
<DL>
<DD>Sets the maximum allowed value specified as data length in the incoming data
 <p>
 Useful for preventing an OutOfMemory attack by the peer.
 The decoder will throw a <A HREF="../../../../../../org/apache/mina/common/BufferDataException.html" title="class in org.apache.mina.common"><CODE>BufferDataException</CODE></A> when data length
 specified in the incoming data is greater than maxDataLength
 The default value is <A HREF="../../../../../../org/apache/mina/filter/codec/prefixedstring/PrefixedStringDecoder.html#DEFAULT_MAX_DATA_LENGTH"><CODE>DEFAULT_MAX_DATA_LENGTH</CODE></A>.
 </p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>maxDataLength</CODE> - maximum allowed value specified as data length in the incoming data</DL>
</DD>
</DL>
<HR>

<A NAME="getMaxDataLength()"><!-- --></A><H3>
getMaxDataLength</H3>
<PRE>
public int <B>getMaxDataLength</B>()</PRE>
<DL>
<DD>Gets the maximum number of bytes allowed for a single String
<P>
<DD><DL>

<DT><B>Returns:</B><DD>maximum number of bytes allowed for a single String</DL>
</DD>
</DL>
<HR>

<A NAME="doDecode(org.apache.mina.common.IoSession, org.apache.mina.common.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><!-- --></A><H3>
doDecode</H3>
<PRE>
protected boolean <B>doDecode</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><B>Description copied from class: <CODE><A HREF="../../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html#doDecode(org.apache.mina.common.IoSession, org.apache.mina.common.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)">CumulativeProtocolDecoder</A></CODE></B></DD>
<DD>Implement this method to consume the specified cumulative buffer and
 decode its content into message(s).
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html#doDecode(org.apache.mina.common.IoSession, org.apache.mina.common.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)">doDecode</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html" title="class in org.apache.mina.filter.codec">CumulativeProtocolDecoder</A></CODE></DL>
</DD>
<DD><DL>
<DD><CODE>in</CODE> - the cumulative buffer
<DT><B>Returns:</B><DD><tt>true</tt> if and only if there's more to decode in the buffer
         and you want to have <tt>doDecode</tt> method invoked again.
         Return <tt>false</tt> if remaining data is not enough to decode,
         then this method will be invoked again when more data is cumulated.
<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 cannot decode <tt>in</tt>.</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/PrefixedStringDecoder.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/prefixedstring/PrefixedStringCodecFactory.html" title="class in org.apache.mina.filter.codec.prefixedstring"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/apache/mina/filter/codec/prefixedstring/PrefixedStringEncoder.html" title="class in org.apache.mina.filter.codec.prefixedstring"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html?org/apache/mina/filter/codec/prefixedstring/PrefixedStringDecoder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PrefixedStringDecoder.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;<A HREF="#constructor_summary">CONSTR</A>&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;<A HREF="#constructor_detail">CONSTR</A>&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>