blob: 089ab22fced687beeb6281af397f3dbd4bc37f6d [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>AbstractMessageDecoder xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/mina/example/sumup/codec/AbstractMessageDecoder.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> *</em>
<a name="19" href="#19">19</a> <em class="jxr_comment"> */</em>
<a name="20" href="#20">20</a> <strong class="jxr_keyword">package</strong> org.apache.mina.example.sumup.codec;
<a name="21" href="#21">21</a>
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.buffer.IoBuffer;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.session.IoSession;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.mina.example.sumup.message.AbstractMessage;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.mina.filter.codec.ProtocolDecoderOutput;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.mina.filter.codec.demux.MessageDecoder;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.mina.filter.codec.demux.MessageDecoderResult;
<a name="28" href="#28">28</a>
<a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * A {@link MessageDecoder} that decodes message header and forwards</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * the decoding of body to a subclass.</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> *</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @author The Apache MINA Project (dev@mina.apache.org)</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> */</em>
<a name="35" href="#35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/mina/example/sumup/codec/AbstractMessageDecoder.html">AbstractMessageDecoder</a> implements <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoder.html">MessageDecoder</a> {
<a name="36" href="#36">36</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> type;
<a name="37" href="#37">37</a>
<a name="38" href="#38">38</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> sequence;
<a name="39" href="#39">39</a>
<a name="40" href="#40">40</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> readHeader;
<a name="41" href="#41">41</a>
<a name="42" href="#42">42</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/mina/example/sumup/codec/AbstractMessageDecoder.html">AbstractMessageDecoder</a>(<strong class="jxr_keyword">int</strong> type) {
<a name="43" href="#43">43</a> <strong class="jxr_keyword">this</strong>.type = type;
<a name="44" href="#44">44</a> }
<a name="45" href="#45">45</a>
<a name="46" href="#46">46</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html">MessageDecoderResult</a> decodable(<a href="../../../../../../org/apache/mina/core/session/IoSession.html">IoSession</a> session, <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> in) {
<a name="47" href="#47">47</a> <em class="jxr_comment">// Return NEED_DATA if the whole header is not read yet.</em>
<a name="48" href="#48">48</a> <strong class="jxr_keyword">if</strong> (in.remaining() &lt; Constants.HEADER_LEN) {
<a name="49" href="#49">49</a> <strong class="jxr_keyword">return</strong> MessageDecoderResult.NEED_DATA;
<a name="50" href="#50">50</a> }
<a name="51" href="#51">51</a>
<a name="52" href="#52">52</a> <em class="jxr_comment">// Return OK if type and bodyLength matches.</em>
<a name="53" href="#53">53</a> <strong class="jxr_keyword">if</strong> (type == in.getShort()) {
<a name="54" href="#54">54</a> <strong class="jxr_keyword">return</strong> MessageDecoderResult.OK;
<a name="55" href="#55">55</a> }
<a name="56" href="#56">56</a>
<a name="57" href="#57">57</a> <em class="jxr_comment">// Return NOT_OK if not matches.</em>
<a name="58" href="#58">58</a> <strong class="jxr_keyword">return</strong> MessageDecoderResult.NOT_OK;
<a name="59" href="#59">59</a> }
<a name="60" href="#60">60</a>
<a name="61" href="#61">61</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/mina/filter/codec/demux/MessageDecoderResult.html">MessageDecoderResult</a> decode(<a href="../../../../../../org/apache/mina/core/session/IoSession.html">IoSession</a> session, <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> in,
<a name="62" href="#62">62</a> <a href="../../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html">ProtocolDecoderOutput</a> out) <strong class="jxr_keyword">throws</strong> Exception {
<a name="63" href="#63">63</a> <em class="jxr_comment">// Try to skip header if not read.</em>
<a name="64" href="#64">64</a> <strong class="jxr_keyword">if</strong> (!readHeader) {
<a name="65" href="#65">65</a> in.getShort(); <em class="jxr_comment">// Skip 'type'.</em>
<a name="66" href="#66">66</a> sequence = in.getInt(); <em class="jxr_comment">// Get 'sequence'.</em>
<a name="67" href="#67">67</a> readHeader = <strong class="jxr_keyword">true</strong>;
<a name="68" href="#68">68</a> }
<a name="69" href="#69">69</a>
<a name="70" href="#70">70</a> <em class="jxr_comment">// Try to decode body</em>
<a name="71" href="#71">71</a> <a href="../../../../../../org/apache/mina/example/sumup/message/AbstractMessage.html">AbstractMessage</a> m = decodeBody(session, in);
<a name="72" href="#72">72</a> <em class="jxr_comment">// Return NEED_DATA if the body is not fully read.</em>
<a name="73" href="#73">73</a> <strong class="jxr_keyword">if</strong> (m == <strong class="jxr_keyword">null</strong>) {
<a name="74" href="#74">74</a> <strong class="jxr_keyword">return</strong> MessageDecoderResult.NEED_DATA;
<a name="75" href="#75">75</a> } <strong class="jxr_keyword">else</strong> {
<a name="76" href="#76">76</a> readHeader = false; <em class="jxr_comment">// reset readHeader for the next decode</em>
<a name="77" href="#77">77</a> }
<a name="78" href="#78">78</a> m.setSequence(sequence);
<a name="79" href="#79">79</a> out.write(m);
<a name="80" href="#80">80</a>
<a name="81" href="#81">81</a> <strong class="jxr_keyword">return</strong> MessageDecoderResult.OK;
<a name="82" href="#82">82</a> }
<a name="83" href="#83">83</a>
<a name="84" href="#84">84</a> <em class="jxr_javadoccomment">/**</em>
<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @return &lt;tt&gt;null&lt;/tt&gt; if the whole body is not read yet</em>
<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em>
<a name="87" href="#87">87</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <a href="../../../../../../org/apache/mina/example/sumup/message/AbstractMessage.html">AbstractMessage</a> decodeBody(<a href="../../../../../../org/apache/mina/core/session/IoSession.html">IoSession</a> session,
<a name="88" href="#88">88</a> <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> in);
<a name="89" href="#89">89</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>