| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_55) on Mon Sep 15 17:28:19 CEST 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>TextLineDecoder (Apache MINA 2.0.8 API)</title> |
| <meta name="date" content="2014-09-15"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TextLineDecoder (Apache MINA 2.0.8 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TextLineDecoder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineCodecFactory.html" title="class in org.apache.mina.filter.codec.textline"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineEncoder.html" title="class in org.apache.mina.filter.codec.textline"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mina/filter/codec/textline/TextLineDecoder.html" target="_top">Frames</a></li> |
| <li><a href="TextLineDecoder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.mina.filter.codec.textline</div> |
| <h2 title="Class TextLineDecoder" class="title">Class TextLineDecoder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mina.filter.codec.textline.TextLineDecoder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoder</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/mina/example/tapedeck/CommandDecoder.html" title="class in org.apache.mina.example.tapedeck">CommandDecoder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">TextLineDecoder</span> |
| extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoder</a></pre> |
| <div class="block">A <a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html" title="interface in org.apache.mina.filter.codec"><code>ProtocolDecoder</code></a> which decodes a text line into a string.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd><a href="http://mina.apache.org">Apache MINA Project</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#TextLineDecoder()">TextLineDecoder</a></strong>()</code> |
| <div class="block">Creates a new instance with the current default <a href="http://docs.oracle.com/javase/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.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#TextLineDecoder(java.nio.charset.Charset)">TextLineDecoder</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset)</code> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#TextLineDecoder(java.nio.charset.Charset, org.apache.mina.filter.codec.textline.LineDelimiter)">TextLineDecoder</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset, |
| <a href="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html" title="class in org.apache.mina.filter.codec.textline">LineDelimiter</a> delimiter)</code> |
| <div class="block">Creates a new instance with the specified <tt>charset</tt> |
| and the specified <tt>delimiter</tt>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#TextLineDecoder(java.nio.charset.Charset, java.lang.String)">TextLineDecoder</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimiter)</code> |
| <div class="block">Creates a new instance with the spcified <tt>charset</tt> |
| and the specified <tt>delimiter</tt>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#TextLineDecoder(org.apache.mina.filter.codec.textline.LineDelimiter)">TextLineDecoder</a></strong>(<a href="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html" title="class in org.apache.mina.filter.codec.textline">LineDelimiter</a> delimiter)</code> |
| <div class="block">Creates a new instance with the current default <a href="http://docs.oracle.com/javase/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>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#TextLineDecoder(java.lang.String)">TextLineDecoder</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimiter)</code> |
| <div class="block">Creates a new instance with the current default <a href="http://docs.oracle.com/javase/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>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)">decode</a></strong>(<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> |
| <div class="block">Decodes binary or protocol-specific content into higher-level message objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#dispose(org.apache.mina.core.session.IoSession)">dispose</a></strong>(<a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> session)</code> |
| <div class="block">Releases all resources related with this decoder.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#finishDecode(org.apache.mina.core.session.IoSession, org.apache.mina.filter.codec.ProtocolDecoderOutput)">finishDecode</a></strong>(<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> |
| <div class="block">Invoked when the specified <tt>session</tt> is closed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#getBufferLength()">getBufferLength</a></strong>()</code> |
| <div class="block">Returns the allowed buffer size used to store the decoded line |
| in the Context instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#getMaxLineLength()">getMaxLineLength</a></strong>()</code> |
| <div class="block">Returns the allowed maximum size of the line to be decoded.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#setBufferLength(int)">setBufferLength</a></strong>(int bufferLength)</code> |
| <div class="block">Sets the default buffer size.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#setMaxLineLength(int)">setMaxLineLength</a></strong>(int maxLineLength)</code> |
| <div class="block">Sets the allowed maximum size of the line to be decoded.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineDecoder.html#writeText(org.apache.mina.core.session.IoSession, java.lang.String, org.apache.mina.filter.codec.ProtocolDecoderOutput)">writeText</a></strong>(<a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> session, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text, |
| <a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoderOutput</a> out)</code> |
| <div class="block">By default, this method propagates the decoded line of text to |
| <code>ProtocolDecoderOutput#write(Object)</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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://docs.oracle.com/javase/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></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TextLineDecoder()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TextLineDecoder</h4> |
| <pre>public TextLineDecoder()</pre> |
| <div class="block">Creates a new instance with the current default <a href="http://docs.oracle.com/javase/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.</div> |
| </li> |
| </ul> |
| <a name="TextLineDecoder(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TextLineDecoder</h4> |
| <pre>public TextLineDecoder(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimiter)</pre> |
| <div class="block">Creates a new instance with the current default <a href="http://docs.oracle.com/javase/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>.</div> |
| </li> |
| </ul> |
| <a name="TextLineDecoder(org.apache.mina.filter.codec.textline.LineDelimiter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TextLineDecoder</h4> |
| <pre>public TextLineDecoder(<a href="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html" title="class in org.apache.mina.filter.codec.textline">LineDelimiter</a> delimiter)</pre> |
| <div class="block">Creates a new instance with the current default <a href="http://docs.oracle.com/javase/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>.</div> |
| </li> |
| </ul> |
| <a name="TextLineDecoder(java.nio.charset.Charset)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TextLineDecoder</h4> |
| <pre>public TextLineDecoder(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset)</pre> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| <a name="TextLineDecoder(java.nio.charset.Charset, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TextLineDecoder</h4> |
| <pre>public TextLineDecoder(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> delimiter)</pre> |
| <div class="block">Creates a new instance with the spcified <tt>charset</tt> |
| and the specified <tt>delimiter</tt>.</div> |
| </li> |
| </ul> |
| <a name="TextLineDecoder(java.nio.charset.Charset, org.apache.mina.filter.codec.textline.LineDelimiter)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TextLineDecoder</h4> |
| <pre>public TextLineDecoder(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> charset, |
| <a href="../../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html" title="class in org.apache.mina.filter.codec.textline">LineDelimiter</a> delimiter)</pre> |
| <div class="block">Creates a new instance with the specified <tt>charset</tt> |
| and the specified <tt>delimiter</tt>.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getMaxLineLength()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxLineLength</h4> |
| <pre>public int getMaxLineLength()</pre> |
| <div class="block">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/core/buffer/BufferDataException.html" title="class in org.apache.mina.core.buffer"><code>BufferDataException</code></a>. The default |
| value is <tt>1024</tt> (1KB).</div> |
| </li> |
| </ul> |
| <a name="setMaxLineLength(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxLineLength</h4> |
| <pre>public void setMaxLineLength(int maxLineLength)</pre> |
| <div class="block">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/core/buffer/BufferDataException.html" title="class in org.apache.mina.core.buffer"><code>BufferDataException</code></a>. The default |
| value is <tt>1024</tt> (1KB).</div> |
| </li> |
| </ul> |
| <a name="setBufferLength(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBufferLength</h4> |
| <pre>public void setBufferLength(int bufferLength)</pre> |
| <div class="block">Sets the default buffer size. This buffer is used in the Context |
| to store the decoded line.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bufferLength</code> - The default bufer size</dd></dl> |
| </li> |
| </ul> |
| <a name="getBufferLength()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBufferLength</h4> |
| <pre>public int getBufferLength()</pre> |
| <div class="block">Returns the allowed buffer size used to store the decoded line |
| in the Context instance.</div> |
| </li> |
| </ul> |
| <a name="decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decode</h4> |
| <pre>public void decode(<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://docs.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> |
| <div class="block">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.core.session.IoSession, org.apache.mina.core.buffer.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>.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html#decode(org.apache.mina.core.session.IoSession, org.apache.mina.core.buffer.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></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.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</dd></dl> |
| </li> |
| </ul> |
| <a name="finishDecode(org.apache.mina.core.session.IoSession, org.apache.mina.filter.codec.ProtocolDecoderOutput)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finishDecode</h4> |
| <pre>public void finishDecode(<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://docs.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> |
| <div class="block">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.core.session.IoSession, org.apache.mina.core.buffer.IoBuffer, org.apache.mina.filter.codec.ProtocolDecoderOutput)"><code>ProtocolDecoder.decode(IoSession, IoBuffer, ProtocolDecoderOutput)</code></a> |
| method didn't process completely.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html#finishDecode(org.apache.mina.core.session.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></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.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</dd></dl> |
| </li> |
| </ul> |
| <a name="dispose(org.apache.mina.core.session.IoSession)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dispose</h4> |
| <pre>public void dispose(<a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> session) |
| throws <a href="http://docs.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> |
| <div class="block">Releases all resources related with this decoder.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html#dispose(org.apache.mina.core.session.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></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.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 failed to dispose all resources</dd></dl> |
| </li> |
| </ul> |
| <a name="writeText(org.apache.mina.core.session.IoSession, java.lang.String, org.apache.mina.filter.codec.ProtocolDecoderOutput)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>writeText</h4> |
| <pre>protected void writeText(<a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> session, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text, |
| <a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html" title="interface in org.apache.mina.filter.codec">ProtocolDecoderOutput</a> out)</pre> |
| <div class="block">By default, this method propagates the decoded line of text to |
| <code>ProtocolDecoderOutput#write(Object)</code>. You may override this method to modify |
| the default behavior.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - the <code>IoSession</code> the received data.</dd><dd><code>text</code> - the decoded text</dd><dd><code>out</code> - the upstream <code>ProtocolDecoderOutput</code>.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TextLineDecoder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineCodecFactory.html" title="class in org.apache.mina.filter.codec.textline"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/mina/filter/codec/textline/TextLineEncoder.html" title="class in org.apache.mina.filter.codec.textline"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mina/filter/codec/textline/TextLineDecoder.html" target="_top">Frames</a></li> |
| <li><a href="TextLineDecoder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004–2014 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
