| <!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>DemuxingProtocolDecoder (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="DemuxingProtocolDecoder (Apache MINA 2.0.12 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/DemuxingProtocolDecoder.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/DemuxingProtocolCodecFactory.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/DemuxingProtocolEncoder.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/DemuxingProtocolDecoder.html" target="_top">Frames</a></li> |
| <li><a href="DemuxingProtocolDecoder.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.demux</div> |
| <h2 title="Class DemuxingProtocolDecoder" class="title">Class DemuxingProtocolDecoder</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><a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderAdapter.html" title="class in org.apache.mina.filter.codec">org.apache.mina.filter.codec.ProtocolDecoderAdapter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html" title="class in org.apache.mina.filter.codec">org.apache.mina.filter.codec.CumulativeProtocolDecoder</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mina.filter.codec.demux.DemuxingProtocolDecoder</li> |
| </ul> |
| </li> |
| </ul> |
| </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> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#line.88">DemuxingProtocolDecoder</a> |
| extends <a href="../../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html" title="class in org.apache.mina.filter.codec">CumulativeProtocolDecoder</a></pre> |
| <div class="block">A composite <a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html" title="interface in org.apache.mina.filter.codec"><code>ProtocolDecoder</code></a> that demultiplexes incoming <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer"><code>IoBuffer</code></a> |
| decoding requests into an appropriate <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux"><code>MessageDecoder</code></a>. |
| |
| <h2>Internal mechanism of <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux"><code>MessageDecoder</code></a> selection</h2> |
| <ol> |
| <li> |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html" title="class in org.apache.mina.filter.codec.demux"><code>DemuxingProtocolDecoder</code></a> iterates the list of candidate |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux"><code>MessageDecoder</code></a>s and calls <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-"><code>MessageDecoder.decodable(IoSession, IoBuffer)</code></a>. |
| Initially, all registered <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux"><code>MessageDecoder</code></a>s are candidates. |
| </li> |
| <li> |
| If <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html#NOT_OK"><code>MessageDecoderResult.NOT_OK</code></a> is returned, it is removed from the candidate |
| list. |
| </li> |
| <li> |
| If <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html#NEED_DATA"><code>MessageDecoderResult.NEED_DATA</code></a> is returned, it is retained in the candidate |
| list, and its <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-"><code>MessageDecoder.decodable(IoSession, IoBuffer)</code></a> will be invoked |
| again when more data is received. |
| </li> |
| <li> |
| If <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html#OK"><code>MessageDecoderResult.OK</code></a> is returned, <a href="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html" title="class in org.apache.mina.filter.codec.demux"><code>DemuxingProtocolDecoder</code></a> |
| found the right <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux"><code>MessageDecoder</code></a>. |
| </li> |
| <li> |
| If there's no candidate left, an exception is raised. Otherwise, |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html" title="class in org.apache.mina.filter.codec.demux"><code>DemuxingProtocolDecoder</code></a> will keep iterating the candidate list. |
| </li> |
| </ol> |
| |
| Please note that any change of position and limit of the specified <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer"><code>IoBuffer</code></a> |
| in <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html#decodable-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-"><code>MessageDecoder.decodable(IoSession, IoBuffer)</code></a> will be reverted back to its |
| original value. |
| <p> |
| Once a <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux"><code>MessageDecoder</code></a> is selected, <a href="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html" title="class in org.apache.mina.filter.codec.demux"><code>DemuxingProtocolDecoder</code></a> calls |
| <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>MessageDecoder.decode(IoSession, IoBuffer, ProtocolDecoderOutput)</code></a> continuously |
| reading its return value: |
| <ul> |
| <li> |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html#NOT_OK"><code>MessageDecoderResult.NOT_OK</code></a> - protocol violation; <a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderException.html" title="class in org.apache.mina.filter.codec"><code>ProtocolDecoderException</code></a> |
| is raised automatically. |
| </li> |
| <li> |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html#NEED_DATA"><code>MessageDecoderResult.NEED_DATA</code></a> - needs more data to read the whole message; |
| <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>MessageDecoder.decode(IoSession, IoBuffer, ProtocolDecoderOutput)</code></a> |
| will be invoked again when more data is received. |
| </li> |
| <li> |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html#OK"><code>MessageDecoderResult.OK</code></a> - successfully decoded a message; the candidate list will |
| be reset and the selection process will start over. |
| </li> |
| </ul></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/MessageDecoderFactory.html" title="interface in org.apache.mina.filter.codec.demux"><code>MessageDecoderFactory</code></a>, |
| <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux"><code>MessageDecoder</code></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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#DemuxingProtocolDecoder--">DemuxingProtocolDecoder</a></span>()</code> </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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#addMessageDecoder-java.lang.Class-">addMessageDecoder</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux">MessageDecoder</a>> decoderClass)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#addMessageDecoder-org.apache.mina.filter.codec.demux.MessageDecoder-">addMessageDecoder</a></span>(<a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux">MessageDecoder</a> decoder)</code> </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/DemuxingProtocolDecoder.html#addMessageDecoder-org.apache.mina.filter.codec.demux.MessageDecoderFactory-">addMessageDecoder</a></span>(<a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderFactory.html" title="interface in org.apache.mina.filter.codec.demux">MessageDecoderFactory</a> factory)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#dispose-org.apache.mina.core.session.IoSession-">dispose</a></span>(<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 the cumulative buffer used by the specified <tt>session</tt>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#doDecode-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-org.apache.mina.filter.codec.ProtocolDecoderOutput-">doDecode</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">Implement this method to consume the specified cumulative buffer and |
| decode its content into message(s).</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.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">Override this method to deal with the closed connection.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.filter.codec.CumulativeProtocolDecoder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.mina.filter.codec.<a href="../../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html" title="class in org.apache.mina.filter.codec">CumulativeProtocolDecoder</a></h3> |
| <code><a href="../../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html#decode-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-org.apache.mina.filter.codec.ProtocolDecoderOutput-">decode</a></code></li> |
| </ul> |
| <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="DemuxingProtocolDecoder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DemuxingProtocolDecoder</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#line.96">DemuxingProtocolDecoder</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addMessageDecoder-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMessageDecoder</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#line.100">addMessageDecoder</a>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux">MessageDecoder</a>> decoderClass)</pre> |
| </li> |
| </ul> |
| <a name="addMessageDecoder-org.apache.mina.filter.codec.demux.MessageDecoder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMessageDecoder</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#line.122">addMessageDecoder</a>(<a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html" title="interface in org.apache.mina.filter.codec.demux">MessageDecoder</a> decoder)</pre> |
| </li> |
| </ul> |
| <a name="addMessageDecoder-org.apache.mina.filter.codec.demux.MessageDecoderFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMessageDecoder</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#line.126">addMessageDecoder</a>(<a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderFactory.html" title="interface in org.apache.mina.filter.codec.demux">MessageDecoderFactory</a> factory)</pre> |
| </li> |
| </ul> |
| <a name="doDecode-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>doDecode</h4> |
| <pre>protected boolean <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#line.141">doDecode</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">Implement this method to consume the specified cumulative buffer and |
| decode its content into message(s).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html#doDecode-org.apache.mina.core.session.IoSession-org.apache.mina.core.buffer.IoBuffer-org.apache.mina.filter.codec.ProtocolDecoderOutput-">doDecode</a></code> in class <code><a href="../../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html" title="class in org.apache.mina.filter.codec">CumulativeProtocolDecoder</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The current Session</dd> |
| <dd><code>in</code> - the cumulative buffer</dd> |
| <dd><code>out</code> - The <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 message</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> if and only if there's more to decode in the buffer |
| and you want to have <tt>doDecode</tt> method invoked again. |
| Return <tt>false</tt> if remaining data is not enough to decode, |
| then this method will be invoked again when more data is |
| cumulated.</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 cannot decode <tt>in</tt>.</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 <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#line.211">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">Override this method to deal with the closed connection. |
| The default implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderAdapter.html#finishDecode-org.apache.mina.core.session.IoSession-org.apache.mina.filter.codec.ProtocolDecoderOutput-">finishDecode</a></code> in class <code><a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderAdapter.html" title="class in org.apache.mina.filter.codec">ProtocolDecoderAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The current Session</dd> |
| <dd><code>out</code> - The <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 message</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="dispose-org.apache.mina.core.session.IoSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>dispose</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/mina/filter/codec/demux/DemuxingProtocolDecoder.html#line.226">dispose</a>(<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 the cumulative buffer used by the specified <tt>session</tt>. |
| Please don't forget to call <tt>super.dispose( session )</tt> when you |
| override this method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html#dispose-org.apache.mina.core.session.IoSession-">dispose</a></code> in class <code><a href="../../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html" title="class in org.apache.mina.filter.codec">CumulativeProtocolDecoder</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The current Session</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 failed to dispose all resources</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/DemuxingProtocolDecoder.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/DemuxingProtocolCodecFactory.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/DemuxingProtocolEncoder.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/DemuxingProtocolDecoder.html" target="_top">Frames</a></li> |
| <li><a href="DemuxingProtocolDecoder.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–2016 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
