prefixedstringcodecfactory.html

MINA+API 关于MINA的API

<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="getEncoderMaxDataLength()"><!-- --></A><H3>
getEncoderMaxDataLength</H3>
<PRE>
public int <B>getEncoderMaxDataLength</B>()</PRE>
<DL>
<DD>Returns the allowed maximum size of an encoded string.
 If the size of the encoded String exceeds this value, the encoder
 will throw a <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalArgumentException</CODE></A>.
 The default value is <A HREF="../../../../../../org/apache/mina/filter/codec/prefixedstring/PrefixedStringEncoder.html#DEFAULT_MAX_DATA_LENGTH"><CODE>PrefixedStringEncoder.DEFAULT_MAX_DATA_LENGTH</CODE></A>.
 <p/>
 This method does the same job as <A HREF="../../../../../../org/apache/mina/filter/codec/prefixedstring/PrefixedStringEncoder.html#setMaxDataLength(int)"><CODE>PrefixedStringEncoder.setMaxDataLength(int)</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the allowed maximum size of an encoded string.</DL>
</DD>
</DL>
<HR>

<A NAME="setEncoderMaxDataLength(int)"><!-- --></A><H3>
setEncoderMaxDataLength</H3>
<PRE>
public void <B>setEncoderMaxDataLength</B>(int&nbsp;maxDataLength)</PRE>
<DL>
<DD>Sets the allowed maximum size of an encoded String.
 If the size of the encoded String exceeds this value, the encoder
 will throw a <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalArgumentException</CODE></A>.
 The default value is <A HREF="../../../../../../org/apache/mina/filter/codec/prefixedstring/PrefixedStringEncoder.html#DEFAULT_MAX_DATA_LENGTH"><CODE>PrefixedStringEncoder.DEFAULT_MAX_DATA_LENGTH</CODE></A>.
 <p/>
 This method does the same job as <A HREF="../../../../../../org/apache/mina/filter/codec/prefixedstring/PrefixedStringEncoder.html#getMaxDataLength()"><CODE>PrefixedStringEncoder.getMaxDataLength()</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>maxDataLength</CODE> - allowed maximum size of an encoded String.</DL>
</DD>
</DL>
<HR>

<A NAME="getDecoderMaxDataLength()"><!-- --></A><H3>
getDecoderMaxDataLength</H3>
<PRE>
public int <B>getDecoderMaxDataLength</B>()</PRE>
<DL>
<DD>Returns the allowed maximum size of a decoded string.
 <p>
 This method does the same job as <A HREF="../../../../../../org/apache/mina/filter/codec/prefixedstring/PrefixedStringEncoder.html#setMaxDataLength(int)"><CODE>PrefixedStringEncoder.setMaxDataLength(int)</CODE></A>.
 </p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the allowed maximum size of an encoded string.<DT><B>See Also:</B><DD><A HREF="../../../../../../org/apache/mina/filter/codec/prefixedstring/PrefixedStringCodecFactory.html#setDecoderMaxDataLength(int)"><CODE>setDecoderMaxDataLength(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setDecoderMaxDataLength(int)"><!-- --></A><H3>
setDecoderMaxDataLength</H3>
<PRE>
public void <B>setDecoderMaxDataLength</B>(int&nbsp;maxDataLength)</PRE>
<DL>
<DD>Sets the maximum allowed value specified as data length in the decoded 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>PrefixedStringDecoder.DEFAULT_MAX_DATA_LENGTH</CODE></A>.

 This method does the same job as <A HREF="../../../../../../org/apache/mina/filter/codec/prefixedstring/PrefixedStringDecoder.html#setMaxDataLength(int)"><CODE>PrefixedStringDecoder.setMaxDataLength(int)</CODE></A>.
 </p>
<P>
<DD><DL>
</DL>
</DD>
<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="setDecoderPrefixLength(int)"><!-- --></A><H3>
setDecoderPrefixLength</H3>
<PRE>
public void <B>setDecoderPrefixLength</B>(int&nbsp;prefixLength)</PRE>
<DL>
<DD>Sets the length of the prefix used by the decoder
<P>
<DD><DL>
</DL>
</DD>
<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="getDecoderPrefixLength()"><!-- --></A><H3>
getDecoderPrefixLength</H3>
<PRE>
public int <B>getDecoderPrefixLength</B>()</PRE>
<DL>
<DD>Gets the length of the length prefix (1, 2, or 4) used by the decoder
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

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

<A NAME="setEncoderPrefixLength(int)"><!-- --></A><H3>
setEncoderPrefixLength</H3>
<PRE>
public void <B>setEncoderPrefixLength</B>(int&nbsp;prefixLength)</PRE>
<DL>
<DD>Sets the length of the prefix used by the encoder
<P>
<DD><DL>
</DL>
</DD>
<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="getEncoderPrefixLength()"><!-- --></A><H3>
getEncoderPrefixLength</H3>
<PRE>
public int <B>getEncoderPrefixLength</B>()</PRE>
<DL>
<DD>Gets the length of the length prefix (1, 2, or 4) used by the encoder
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

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

<A NAME="getEncoder(org.apache.mina.common.IoSession)"><!-- --></A><H3>
getEncoder</H3>
<PRE>
public <A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolEncoder.html" title="interface in org.apache.mina.filter.codec">ProtocolEncoder</A> <B>getEncoder</B>(<A HREF="../../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A>&nbsp;session)
                           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 interface: <CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolCodecFactory.html#getEncoder(org.apache.mina.common.IoSession)">ProtocolCodecFactory</A></CODE></B></DD>
<DD>Returns a new (or reusable) instance of <A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolEncoder.html" title="interface in org.apache.mina.filter.codec"><CODE>ProtocolEncoder</CODE></A> which
 encodes message objects into binary or protocol-specific data.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolCodecFactory.html#getEncoder(org.apache.mina.common.IoSession)">getEncoder</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolCodecFactory.html" title="interface in org.apache.mina.filter.codec">ProtocolCodecFactory</A></CODE></DL>
</DD>
<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></DL>
</DD>
</DL>
<HR>

<A NAME="getDecoder(org.apache.mina.common.IoSession)"><!-- --></A><H3>
getDecoder</H3>
<PRE>
public <A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoder</A> <B>getDecoder</B>(<A HREF="../../../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</A>&nbsp;session)
                           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 interface: <CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolCodecFactory.html#getDecoder(org.apache.mina.common.IoSession)">ProtocolCodecFactory</A></CODE></B></DD>
<DD>Returns a new (or reusable) instance of <A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html" title="interface in org.apache.mina.filter.codec"><CODE>ProtocolDecoder</CODE></A> which
 decodes binary or protocol-specific data into message objects.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolCodecFactory.html#getDecoder(org.apache.mina.common.IoSession)">getDecoder</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolCodecFactory.html" title="interface in org.apache.mina.filter.codec">ProtocolCodecFactory</A></CODE></DL>
</DD>
<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></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/PrefixedStringCodecFactory.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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../../org/apache/mina/filter/codec/prefixedstring/PrefixedStringDecoder.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/PrefixedStringCodecFactory.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PrefixedStringCodecFactory.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;FIELD&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;FIELD&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>