| <!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_191) on Sat Mar 16 03:37:20 CET 2019 --> |
| <title>AbstractMessageDecoder (Apache MINA API Documentation)</title> |
| <meta name="date" content="2019-03-16"> |
| <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="AbstractMessageDecoder (Apache MINA API Documentation)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AbstractMessageDecoder.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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/mina/examples/sumup/codec/AbstractMessageEncoder.html" title="class in org.apache.mina.examples.sumup.codec"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mina/examples/sumup/codec/AbstractMessageDecoder.html" target="_top">Frames</a></li> |
| <li><a href="AbstractMessageDecoder.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.examples.sumup.codec</div> |
| <h2 title="Class AbstractMessageDecoder" class="title">Class AbstractMessageDecoder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mina.examples.sumup.codec.AbstractMessageDecoder</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/protocol/codec/MessageDecoder.html" title="interface in org.apache.mina.protocol.codec">MessageDecoder</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/mina/examples/sumup/codec/AddMessageDecoder.html" title="class in org.apache.mina.examples.sumup.codec">AddMessageDecoder</a>, <a href="../../../../../../org/apache/mina/examples/sumup/codec/ResultMessageDecoder.html" title="class in org.apache.mina.examples.sumup.codec">ResultMessageDecoder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AbstractMessageDecoder</span> |
| extends java.lang.Object |
| implements <a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html" title="interface in org.apache.mina.protocol.codec">MessageDecoder</a></pre> |
| <div class="block">A <a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html" title="interface in org.apache.mina.protocol.codec"><code>MessageDecoder</code></a> that decodes message header and forwards |
| the decoding of body to a subclass.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Rev: 209237 $, $Date: 2005-07-05 09:44:16 +0200 (Tue, 05 Jul 2005) $</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>The Apache Directory Project</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.mina.protocol.codec.MessageDecoder"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.mina.protocol.codec.<a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html" title="interface in org.apache.mina.protocol.codec">MessageDecoder</a></h3> |
| <code><a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#NEED_DATA">NEED_DATA</a>, <a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#NOT_OK">NOT_OK</a>, <a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#OK">OK</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== 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="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/examples/sumup/codec/AbstractMessageDecoder.html#AbstractMessageDecoder-int-">AbstractMessageDecoder</a></span>(int type)</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoderResult.html" title="class in org.apache.mina.protocol.codec">MessageDecoderResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/examples/sumup/codec/AbstractMessageDecoder.html#decodable-org.apache.mina.protocol.ProtocolSession-org.apache.mina.common.ByteBuffer-">decodable</a></span>(<a href="../../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a> session, |
| <a href="../../../../../../org/apache/mina/common/ByteBuffer.html" title="class in org.apache.mina.common">ByteBuffer</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/protocol/codec/MessageDecoderResult.html" title="class in org.apache.mina.protocol.codec">MessageDecoderResult</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/examples/sumup/codec/AbstractMessageDecoder.html#decode-org.apache.mina.protocol.ProtocolSession-org.apache.mina.common.ByteBuffer-org.apache.mina.protocol.ProtocolDecoderOutput-">decode</a></span>(<a href="../../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a> session, |
| <a href="../../../../../../org/apache/mina/common/ByteBuffer.html" title="class in org.apache.mina.common">ByteBuffer</a> in, |
| <a href="../../../../../../org/apache/mina/protocol/ProtocolDecoderOutput.html" title="interface in org.apache.mina.protocol">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>protected abstract <a href="../../../../../../org/apache/mina/examples/sumup/message/AbstractMessage.html" title="class in org.apache.mina.examples.sumup.message">AbstractMessage</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/examples/sumup/codec/AbstractMessageDecoder.html#decodeBody-org.apache.mina.protocol.ProtocolSession-org.apache.mina.common.ByteBuffer-">decodeBody</a></span>(<a href="../../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a> session, |
| <a href="../../../../../../org/apache/mina/common/ByteBuffer.html" title="class in org.apache.mina.common">ByteBuffer</a> in)</code> </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.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="AbstractMessageDecoder-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractMessageDecoder</h4> |
| <pre>protected AbstractMessageDecoder(int type)</pre> |
| </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.protocol.ProtocolSession-org.apache.mina.common.ByteBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decodable</h4> |
| <pre>public <a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoderResult.html" title="class in org.apache.mina.protocol.codec">MessageDecoderResult</a> decodable(<a href="../../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a> session, |
| <a href="../../../../../../org/apache/mina/common/ByteBuffer.html" title="class in org.apache.mina.common">ByteBuffer</a> in)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#decodable-org.apache.mina.protocol.ProtocolSession-org.apache.mina.common.ByteBuffer-">MessageDecoder</a></code></span></div> |
| <div class="block">Checks the specified buffer is decodable by this decoder.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#decodable-org.apache.mina.protocol.ProtocolSession-org.apache.mina.common.ByteBuffer-">decodable</a></code> in interface <code><a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html" title="interface in org.apache.mina.protocol.codec">MessageDecoder</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#OK"><code>MessageDecoder.OK</code></a> if this decoder can decode the specified buffer. |
| <a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#NOT_OK"><code>MessageDecoder.NOT_OK</code></a> if this decoder cannot decode the specified buffer. |
| <a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#NEED_DATA"><code>MessageDecoder.NEED_DATA</code></a> if more data is required to determine if the |
| specified buffer is decodable (<a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#OK"><code>MessageDecoder.OK</code></a>) or not decodable |
| <a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#NOT_OK"><code>MessageDecoder.NOT_OK</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="decode-org.apache.mina.protocol.ProtocolSession-org.apache.mina.common.ByteBuffer-org.apache.mina.protocol.ProtocolDecoderOutput-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decode</h4> |
| <pre>public <a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoderResult.html" title="class in org.apache.mina.protocol.codec">MessageDecoderResult</a> decode(<a href="../../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a> session, |
| <a href="../../../../../../org/apache/mina/common/ByteBuffer.html" title="class in org.apache.mina.common">ByteBuffer</a> in, |
| <a href="../../../../../../org/apache/mina/protocol/ProtocolDecoderOutput.html" title="interface in org.apache.mina.protocol">ProtocolDecoderOutput</a> out) |
| throws <a href="../../../../../../org/apache/mina/protocol/ProtocolViolationException.html" title="class in org.apache.mina.protocol">ProtocolViolationException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#decode-org.apache.mina.protocol.ProtocolSession-org.apache.mina.common.ByteBuffer-org.apache.mina.protocol.ProtocolDecoderOutput-">MessageDecoder</a></code></span></div> |
| <div class="block">Decodes binary or protocol-specific content into higher-level message objects. |
| MINA invokes <a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#decode-org.apache.mina.protocol.ProtocolSession-org.apache.mina.common.ByteBuffer-org.apache.mina.protocol.ProtocolDecoderOutput-"><code>MessageDecoder.decode(ProtocolSession, ByteBuffer, ProtocolDecoderOutput)</code></a> |
| method with read data, and then the decoder implementation puts decoded |
| messages into <a href="../../../../../../org/apache/mina/protocol/ProtocolDecoderOutput.html" title="interface in org.apache.mina.protocol"><code>ProtocolDecoderOutput</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#decode-org.apache.mina.protocol.ProtocolSession-org.apache.mina.common.ByteBuffer-org.apache.mina.protocol.ProtocolDecoderOutput-">decode</a></code> in interface <code><a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html" title="interface in org.apache.mina.protocol.codec">MessageDecoder</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#OK"><code>MessageDecoder.OK</code></a> if you finished decoding messages successfully. |
| <a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#NEED_DATA"><code>MessageDecoder.NEED_DATA</code></a> if you need more data to finish decoding current message. |
| <a href="../../../../../../org/apache/mina/protocol/codec/MessageDecoder.html#NOT_OK"><code>MessageDecoder.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="../../../../../../org/apache/mina/protocol/ProtocolViolationException.html" title="class in org.apache.mina.protocol">ProtocolViolationException</a></code> - if the read data violated protocol |
| specification</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="decodeBody-org.apache.mina.protocol.ProtocolSession-org.apache.mina.common.ByteBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>decodeBody</h4> |
| <pre>protected abstract <a href="../../../../../../org/apache/mina/examples/sumup/message/AbstractMessage.html" title="class in org.apache.mina.examples.sumup.message">AbstractMessage</a> decodeBody(<a href="../../../../../../org/apache/mina/protocol/ProtocolSession.html" title="interface in org.apache.mina.protocol">ProtocolSession</a> session, |
| <a href="../../../../../../org/apache/mina/common/ByteBuffer.html" title="class in org.apache.mina.common">ByteBuffer</a> in)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>null</tt> if the whole body is not read yet</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/AbstractMessageDecoder.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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/mina/examples/sumup/codec/AbstractMessageEncoder.html" title="class in org.apache.mina.examples.sumup.codec"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mina/examples/sumup/codec/AbstractMessageDecoder.html" target="_top">Frames</a></li> |
| <li><a href="AbstractMessageDecoder.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 ======= --> |
| </body> |
| </html> |