| <!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 Wed Oct 22 07:01:18 CEST 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>IoBufferDecoder (Apache MINA 2.0.9 API)</title> |
| <meta name="date" content="2014-10-22"> |
| <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="IoBufferDecoder (Apache MINA 2.0.9 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/IoBufferDecoder.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/proxy/utils/ByteUtilities.html" title="class in org.apache.mina.proxy.utils"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/mina/proxy/utils/IoBufferDecoder.DecodingContext.html" title="class in org.apache.mina.proxy.utils"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/proxy/utils/IoBufferDecoder.html" target="_top">Frames</a></li> |
| <li><a href="IoBufferDecoder.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><a href="#nested_class_summary">Nested</a> | </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.proxy.utils</div> |
| <h2 title="Class IoBufferDecoder" class="title">Class IoBufferDecoder</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.proxy.utils.IoBufferDecoder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../src-html/org/apache/mina/proxy/utils/IoBufferDecoder.html#line.35">IoBufferDecoder</a> |
| 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></pre> |
| <div class="block">IoBufferDecoder.java - Handles an <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer"><code>IoBuffer</code></a> decoder which supports |
| two methods : |
| - dynamic delimiter decoding |
| - fixed length content reading</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>MINA 2.0.0-M3</dd> |
| <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"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/utils/IoBufferDecoder.DecodingContext.html" title="class in org.apache.mina.proxy.utils">IoBufferDecoder.DecodingContext</a></strong></code> |
| <div class="block">The class holding the decoding context.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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/proxy/utils/IoBufferDecoder.html#IoBufferDecoder(byte[])">IoBufferDecoder</a></strong>(byte[] delimiter)</code> |
| <div class="block">Creates a new instance that uses specified <tt>delimiter</tt> byte array as a |
| message delimiter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/mina/proxy/utils/IoBufferDecoder.html#IoBufferDecoder(int)">IoBufferDecoder</a></strong>(int contentLength)</code> |
| <div class="block">Creates a new instance that will read messages of <tt>contentLength</tt> bytes.</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><a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/utils/IoBufferDecoder.html#decodeFully(org.apache.mina.core.buffer.IoBuffer)">decodeFully</a></strong>(<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> in)</code> |
| <div class="block">Will return null unless it has enough data to decode.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/utils/IoBufferDecoder.html#setContentLength(int, boolean)">setContentLength</a></strong>(int contentLength, |
| boolean resetMatchCount)</code> |
| <div class="block">Sets the the length of the content line to be decoded.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/utils/IoBufferDecoder.html#setDelimiter(byte[], boolean)">setDelimiter</a></strong>(byte[] delim, |
| boolean resetMatchCount)</code> |
| <div class="block">Dynamically sets a new delimiter.</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="IoBufferDecoder(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>IoBufferDecoder</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/mina/proxy/utils/IoBufferDecoder.html#line.116">IoBufferDecoder</a>(byte[] delimiter)</pre> |
| <div class="block">Creates a new instance that uses specified <tt>delimiter</tt> byte array as a |
| message delimiter.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>delimiter</code> - an array of characters which delimits messages</dd></dl> |
| </li> |
| </ul> |
| <a name="IoBufferDecoder(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>IoBufferDecoder</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/mina/proxy/utils/IoBufferDecoder.html#line.125">IoBufferDecoder</a>(int contentLength)</pre> |
| <div class="block">Creates a new instance that will read messages of <tt>contentLength</tt> bytes.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>contentLength</code> - the exact length to read</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setContentLength(int, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentLength</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/mina/proxy/utils/IoBufferDecoder.html#line.138">setContentLength</a>(int contentLength, |
| boolean resetMatchCount)</pre> |
| <div class="block">Sets the the length of the content line to be decoded. |
| When set, it overrides the dynamic delimiter setting and content length |
| method will be used for decoding on the next decodeOnce call. |
| The default value is <tt>-1</tt>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>contentLength</code> - the content length to match</dd><dd><code>resetMatchCount</code> - delimiter matching is reset if true</dd></dl> |
| </li> |
| </ul> |
| <a name="setDelimiter(byte[], boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDelimiter</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/mina/proxy/utils/IoBufferDecoder.html#line.160">setDelimiter</a>(byte[] delim, |
| boolean resetMatchCount)</pre> |
| <div class="block">Dynamically sets a new delimiter. Next time |
| <a href="../../../../../org/apache/mina/proxy/utils/IoBufferDecoder.html#decodeFully(org.apache.mina.core.buffer.IoBuffer)"><code>decodeFully(IoBuffer)</code></a> will be called it will use the new |
| delimiter. Delimiter matching is reset only if <tt>resetMatchCount</tt> is true but |
| decoding will continue from current position. |
| |
| NB : Delimiter <a href="../../../../../org/apache/mina/filter/codec/textline/LineDelimiter.html#AUTO"><code>LineDelimiter.AUTO</code></a> is not allowed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>delim</code> - the new delimiter as a byte array</dd><dd><code>resetMatchCount</code> - delimiter matching is reset if true</dd></dl> |
| </li> |
| </ul> |
| <a name="decodeFully(org.apache.mina.core.buffer.IoBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>decodeFully</h4> |
| <pre>public <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> <a href="../../../../../src-html/org/apache/mina/proxy/utils/IoBufferDecoder.html#line.185">decodeFully</a>(<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> in)</pre> |
| <div class="block">Will return null unless it has enough data to decode. If <code>contentLength</code> |
| is set then it tries to retrieve <code>contentLength</code> bytes from the buffer |
| otherwise it will scan the buffer to find the data <code>delimiter</code> and return |
| all the data and the trailing delimiter.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the data to decode</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/IoBufferDecoder.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/proxy/utils/ByteUtilities.html" title="class in org.apache.mina.proxy.utils"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/mina/proxy/utils/IoBufferDecoder.DecodingContext.html" title="class in org.apache.mina.proxy.utils"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/proxy/utils/IoBufferDecoder.html" target="_top">Frames</a></li> |
| <li><a href="IoBufferDecoder.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><a href="#nested_class_summary">Nested</a> | </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> |