| <!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 (1.8.0_60) on Wed Feb 03 10:01:28 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>MessageDecoder (Apache MINA 2.0.12 API)</title> |
| <meta name="date" content="2016-02-03"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MessageDecoder (Apache MINA 2.0.12 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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/MessageDecoder.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/demux/DemuxingProtocolEncoder.html" title="class in org.apache.mina.filter.codec.demux"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderAdapter.html" title="class in org.apache.mina.filter.codec.demux"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mina/filter/codec/demux/MessageDecoder.html" target="_top">Frames</a></li> |
| <li><a href="MessageDecoder.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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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.demux</div> |
| <h2 title="Interface MessageDecoder" class="title">Interface MessageDecoder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/mina/example/sumup/codec/AbstractMessageDecoder.html" title="class in org.apache.mina.example.sumup.codec">AbstractMessageDecoder</a>, <a href="../../../../../../org/apache/mina/example/sumup/codec/AddMessageDecoder.html" title="class in org.apache.mina.example.sumup.codec">AddMessageDecoder</a>, <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderAdapter.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderAdapter</a>, <a href="../../../../../../org/apache/mina/example/sumup/codec/ResultMessageDecoder.html" title="class in org.apache.mina.example.sumup.codec">ResultMessageDecoder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/MessageDecoder.html#line.38">MessageDecoder</a></pre> |
| <div class="block">Decodes a certain type of messages. |
| <p> |
| We didn't provide any <tt>dispose</tt> method for <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux"><code>MessageDecoder</code></a> |
| because it can give you performance penalty in case you have a lot of |
| message types to handle.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="http://mina.apache.org">Apache MINA Project</a></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html" title="class in org.apache.mina.filter.codec.demux"><code>DemuxingProtocolDecoder</code></a>, |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderFactory.html" title="interface in org.apache.mina.filter.codec.demux"><code>MessageDecoderFactory</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NEED_DATA">NEED_DATA</a></span></code> |
| <div class="block">Represents a result from <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-"><code>decodable(IoSession, IoBuffer)</code></a> and |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-org.apache.mina.filter.codec.ProtocolDecoderOutput-"><code>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NOT_OK">NOT_OK</a></span></code> |
| <div class="block">Represents a result from <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-"><code>decodable(IoSession, IoBuffer)</code></a> and |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-org.apache.mina.filter.codec.ProtocolDecoderOutput-"><code>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#OK">OK</a></span></code> |
| <div class="block">Represents a result from <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-"><code>decodable(IoSession, IoBuffer)</code></a> and |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-org.apache.mina.filter.codec.ProtocolDecoderOutput-"><code>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</code></a>.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-">decodable</a></span>(<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)</code> |
| <div class="block">Checks the specified buffer is decodable by this decoder.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-org.apache.mina.filter.codec.ProtocolDecoderOutput-">decode</a></span>(<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 id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#finishDecode-org.apache.mina.core.session.IoSession-org.apache.mina.filter.codec.ProtocolDecoderOutput-">finishDecode</a></span>(<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 while this decoder was |
| parsing the data.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="OK"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OK</h4> |
| <pre>static final <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</a> <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/MessageDecoder.html#line.44">OK</a></pre> |
| <div class="block">Represents a result from <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-"><code>decodable(IoSession, IoBuffer)</code></a> and |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-org.apache.mina.filter.codec.ProtocolDecoderOutput-"><code>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</code></a>. Please |
| refer to each method's documentation for detailed explanation.</div> |
| </li> |
| </ul> |
| <a name="NEED_DATA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NEED_DATA</h4> |
| <pre>static final <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</a> <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/MessageDecoder.html#line.51">NEED_DATA</a></pre> |
| <div class="block">Represents a result from <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-"><code>decodable(IoSession, IoBuffer)</code></a> and |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-org.apache.mina.filter.codec.ProtocolDecoderOutput-"><code>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</code></a>. Please |
| refer to each method's documentation for detailed explanation.</div> |
| </li> |
| </ul> |
| <a name="NOT_OK"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NOT_OK</h4> |
| <pre>static final <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</a> <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/MessageDecoder.html#line.58">NOT_OK</a></pre> |
| <div class="block">Represents a result from <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-"><code>decodable(IoSession, IoBuffer)</code></a> and |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decode-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-org.apache.mina.filter.codec.ProtocolDecoderOutput-"><code>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</code></a>. Please |
| refer to each method's documentation for detailed explanation.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="decodable-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decodable</h4> |
| <pre><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</a> <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/MessageDecoder.html#line.71">decodable</a>(<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)</pre> |
| <div class="block">Checks the specified buffer is decodable by this decoder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The current session</dd> |
| <dd><code>in</code> - The buffer containing the data to decode</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#OK"><code>OK</code></a> if this decoder can decode the specified buffer. |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NOT_OK"><code>NOT_OK</code></a> if this decoder cannot decode the specified buffer. |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NEED_DATA"><code>NEED_DATA</code></a> if more data is required to determine if the |
| specified buffer is decodable (<a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#OK"><code>OK</code></a>) or not decodable |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NOT_OK"><code>NOT_OK</code></a>.</dd> |
| </dl> |
| </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><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html" title="class in org.apache.mina.filter.codec.demux">MessageDecoderResult</a> <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/MessageDecoder.html#line.87">decode</a>(<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/demux/MessageDecoder.html#decode-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-org.apache.mina.filter.codec.ProtocolDecoderOutput-"><code>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><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The current session</dd> |
| <dd><code>in</code> - The buffer containing the data to decode</dd> |
| <dd><code>out</code> - The instance of <a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html" title="interface in org.apache.mina.filter.codec"><code>ProtocolDecoderOutput</code></a> that will receive the decoded messages</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#OK"><code>OK</code></a> if you finished decoding messages successfully. |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NEED_DATA"><code>NEED_DATA</code></a> if you need more data to finish decoding current message. |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#NOT_OK"><code>NOT_OK</code></a> if you cannot decode current message due to protocol specification violation.</dd> |
| <dt><span class="throwsLabel">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="blockListLast"> |
| <li class="blockList"> |
| <h4>finishDecode</h4> |
| <pre>void <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/MessageDecoder.html#line.101">finishDecode</a>(<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 while this decoder was |
| parsing the data. 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/demux/MessageDecoder.html#decode-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-org.apache.mina.filter.codec.ProtocolDecoderOutput-"><code>decode(IoSession, IoBuffer, ProtocolDecoderOutput)</code></a> method didn't process |
| completely.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The current session</dd> |
| <dd><code>out</code> - The instance of <a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html" title="interface in org.apache.mina.filter.codec"><code>ProtocolDecoderOutput</code></a> that contains the decoded messages</dd> |
| <dt><span class="throwsLabel">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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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/MessageDecoder.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/demux/DemuxingProtocolEncoder.html" title="class in org.apache.mina.filter.codec.demux"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderAdapter.html" title="class in org.apache.mina.filter.codec.demux"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mina/filter/codec/demux/MessageDecoder.html" target="_top">Frames</a></li> |
| <li><a href="MessageDecoder.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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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–2016 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |