textlinedecoder.html

MINA+API 关于MINA的API

<A NAME="TextLineDecoder()"><!-- --></A><H3>
TextLineDecoder</H3>
<PRE>
public <B>TextLineDecoder</B>()</PRE>
<DL>
<DD>Creates a new instance with the current default <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"><CODE>Charset</CODE></A>
 and <A HREF="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html#AUTO"><CODE>LineDelimiter.AUTO</CODE></A> delimiter.
<P>
</DL>
<HR>

<A NAME="TextLineDecoder(java.lang.String)"><!-- --></A><H3>
TextLineDecoder</H3>
<PRE>
public <B>TextLineDecoder</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;delimiter)</PRE>
<DL>
<DD>Creates a new instance with the current default <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"><CODE>Charset</CODE></A>
 and the specified <tt>delimiter</tt>.
<P>
</DL>
<HR>

<A NAME="TextLineDecoder(org.apache.mina.filter.codec.textline.LineDelimiter)"><!-- --></A><H3>
TextLineDecoder</H3>
<PRE>
public <B>TextLineDecoder</B>(<A HREF="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html" title="class in org.apache.mina.filter.codec.textline">LineDelimiter</A>&nbsp;delimiter)</PRE>
<DL>
<DD>Creates a new instance with the current default <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"><CODE>Charset</CODE></A>
 and the specified <tt>delimiter</tt>.
<P>
</DL>
<HR>

<A NAME="TextLineDecoder(java.nio.charset.Charset)"><!-- --></A><H3>
TextLineDecoder</H3>
<PRE>
public <B>TextLineDecoder</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>
<DD>Creates a new instance with the spcified <tt>charset</tt>
 and <A HREF="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html#AUTO"><CODE>LineDelimiter.AUTO</CODE></A> delimiter.
<P>
</DL>
<HR>

<A NAME="TextLineDecoder(java.nio.charset.Charset, java.lang.String)"><!-- --></A><H3>
TextLineDecoder</H3>
<PRE>
public <B>TextLineDecoder</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,
                       <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;delimiter)</PRE>
<DL>
<DD>Creates a new instance with the spcified <tt>charset</tt>
 and the specified <tt>delimiter</tt>.
<P>
</DL>
<HR>

<A NAME="TextLineDecoder(java.nio.charset.Charset, org.apache.mina.filter.codec.textline.LineDelimiter)"><!-- --></A><H3>
TextLineDecoder</H3>
<PRE>
public <B>TextLineDecoder</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,
                       <A HREF="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html" title="class in org.apache.mina.filter.codec.textline">LineDelimiter</A>&nbsp;delimiter)</PRE>
<DL>
<DD>Creates a new instance with the specified <tt>charset</tt>
 and the specified <tt>delimiter</tt>.
<P>
</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="getMaxLineLength()"><!-- --></A><H3>
getMaxLineLength</H3>
<PRE>
public int <B>getMaxLineLength</B>()</PRE>
<DL>
<DD>Returns the allowed maximum size of the line to be decoded.
 If the size of the line to be decoded exceeds this value, the
 decoder will throw a <A HREF="../../../../../../org/apache/mina/common/BufferDataException.html" title="class in org.apache.mina.common"><CODE>BufferDataException</CODE></A>.  The default
 value is <tt>1024</tt> (1KB).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setMaxLineLength(int)"><!-- --></A><H3>
setMaxLineLength</H3>
<PRE>
public void <B>setMaxLineLength</B>(int&nbsp;maxLineLength)</PRE>
<DL>
<DD>Sets the allowed maximum size of the line to be decoded.
 If the size of the line to be decoded exceeds this value, the
 decoder will throw a <A HREF="../../../../../../org/apache/mina/common/BufferDataException.html" title="class in org.apache.mina.common"><CODE>BufferDataException</CODE></A>.  The default
 value is <tt>1024</tt> (1KB).
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</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>
public void <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><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html#decode(org.apache.mina.common.IoSession, org.apache.mina.common.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)">ProtocolDecoder</A></CODE></B></DD>
<DD>Decodes binary or protocol-specific content into higher-level message objects.
 MINA invokes <A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html#decode(org.apache.mina.common.IoSession, org.apache.mina.common.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><CODE>ProtocolDecoder.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>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html#decode(org.apache.mina.common.IoSession, org.apache.mina.common.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)">decode</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoder</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> - 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>
public 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><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html#finishDecode(org.apache.mina.common.IoSession, org.apache.mina.filter.codec.ProtocolDecoderOutput)">ProtocolDecoder</A></CODE></B></DD>
<DD>Invoked when the specified <tt>session</tt> is closed.  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/ProtocolDecoder.html#decode(org.apache.mina.common.IoSession, org.apache.mina.common.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><CODE>ProtocolDecoder.decode(IoSession, IoBuffer, ProtocolDecoderOutput)</CODE></A>
 method didn't process completely.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html#finishDecode(org.apache.mina.common.IoSession, org.apache.mina.filter.codec.ProtocolDecoderOutput)">finishDecode</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoder</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> - if the read data violated protocol specification</DL>
</DD>
</DL>
<HR>

<A NAME="dispose(org.apache.mina.common.IoSession)"><!-- --></A><H3>
dispose</H3>
<PRE>
public void <B>dispose</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/ProtocolDecoder.html#dispose(org.apache.mina.common.IoSession)">ProtocolDecoder</A></CODE></B></DD>
<DD>Releases all resources related with this decoder.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html#dispose(org.apache.mina.common.IoSession)">dispose</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoder</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> - if failed to dispose all resources</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/TextLineDecoder.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/textline/TextLineCodecFactory.html" title="class in org.apache.mina.filter.codec.textline"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../org/apache/mina/filter/codec/textline/TextLineEncoder.html" title="class in org.apache.mina.filter.codec.textline"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html?org/apache/mina/filter/codec/textline/TextLineDecoder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="TextLineDecoder.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>