| <!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>CumulativeProtocolDecoder xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/mina/filter/codec/CumulativeProtocolDecoder.html">View Javadoc</a></div><pre> |
| <a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> |
| <a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">package</strong> org.apache.mina.filter.codec; |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.buffer.IoBuffer; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.service.TransportMetadata; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.session.AttributeKey; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.session.IoSession; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * A {@link ProtocolDecoder} that cumulates the content of received buffers to a</em> |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * <em>cumulative buffer</em> to help users implement decoders.</em> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * If the received {@link IoBuffer} is only a part of a message. decoders should</em> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * cumulate received buffers to make a message complete or to postpone decoding</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * until more buffers arrive.</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * Here is an example decoder that decodes CRLF terminated lines into</em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * <code>Command</code> objects:</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * <pre></em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * public class CrLfTerminatedCommandLineDecoder extends CumulativeProtocolDecoder {</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * private Command parseCommand(IoBuffer in) {</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * // Convert the bytes in the specified buffer to a</em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * // Command object.</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * ...</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * protected boolean doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception {</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * // Remember the initial position.</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * int start = in.position();</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * // Now find the first CRLF in the buffer.</em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * byte previous = 0;</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * while (in.hasRemaining()) {</em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * byte current = in.get();</em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * if (previous == '\r' &amp;&amp; current == '\n') {</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * // Remember the current position and limit.</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * int position = in.position();</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * int limit = in.limit();</em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * try {</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * in.position(start);</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * in.limit(position);</em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * // The bytes between in.position() and in.limit()</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * // now contain a full CRLF terminated line.</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * out.write(parseCommand(in.slice()));</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * } finally {</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * // Set the position to point right after the</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * // detected line and set the limit to the old</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * // one.</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * in.position(position);</em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * in.limit(limit);</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * // Decoded one line; CumulativeProtocolDecoder will</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * // call me again until I return false. So just</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * // return true until there are no more lines in the</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * // buffer.</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * return true;</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * previous = current;</em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * // Could not find CRLF in the buffer. Reset the initial</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * // position to the one we recorded above.</em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * in.position(start);</em> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * return false;</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * }</em> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * </pre></em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * Please note that this decoder simply forward the call to</em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * {@link #doDecode(IoSession, IoBuffer, ProtocolDecoderOutput)} if the</em> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * underlying transport doesn't have a packet fragmentation. Whether the</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * transport has fragmentation or not is determined by querying</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * {@link TransportMetadata}.</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="http://mina.apache.org" target="alexandria_uri">http://mina.apache.org</a>">Apache MINA Project</a></em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html">CumulativeProtocolDecoder</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/mina/filter/codec/ProtocolDecoderAdapter.html">ProtocolDecoderAdapter</a> { |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/core/session/AttributeKey.html">AttributeKey</a> BUFFER = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/mina/core/session/AttributeKey.html">AttributeKey</a>(getClass(), <span class="jxr_string">"buffer"</span>); |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * Creates a new instance.</em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/mina/filter/codec/CumulativeProtocolDecoder.html">CumulativeProtocolDecoder</a>() { |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_comment">// Do nothing</em> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> } |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * Cumulates content of <tt>in</tt> into internal buffer and forwards</em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * decoding request to</em> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * {@link #doDecode(IoSession, IoBuffer, ProtocolDecoderOutput)}.</em> |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * <tt>doDecode()</tt> is invoked repeatedly until it returns <tt>false</tt></em> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * and the cumulative buffer is compacted after decoding ends.</em> |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException</em> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * if your <tt>doDecode()</tt> returned <tt>true</tt> not</em> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * consuming the cumulative buffer.</em> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> 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 href="../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html">ProtocolDecoderOutput</a> out) <strong class="jxr_keyword">throws</strong> Exception { |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">if</strong> (!session.getTransportMetadata().hasFragmentation()) { |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">while</strong> (in.hasRemaining()) { |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">if</strong> (!doDecode(session, in, out)) { |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> } |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> } |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">return</strong>; |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> } |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">boolean</strong> usingSessionBuffer = <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> buf = (IoBuffer) session.getAttribute(BUFFER); |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_comment">// If we have a session buffer, append data to that; otherwise</em> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_comment">// use the buffer read from the network directly.</em> |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">if</strong> (buf != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">boolean</strong> appended = false; |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_comment">// Make sure that the buffer is auto-expanded.</em> |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">if</strong> (buf.isAutoExpand()) { |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> buf.put(in); |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> appended = <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> } <strong class="jxr_keyword">catch</strong> (IllegalStateException e) { |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_comment">// A user called derivation method (e.g. slice()),</em> |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_comment">// which disables auto-expansion of the parent buffer.</em> |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> } <strong class="jxr_keyword">catch</strong> (IndexOutOfBoundsException e) { |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_comment">// A user disabled auto-expansion.</em> |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> } |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> } |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">if</strong> (appended) { |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> buf.flip(); |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_comment">// Reallocate the buffer if append operation failed due to</em> |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_comment">// derivation or disabled auto-expansion.</em> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> buf.flip(); |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> newBuf = IoBuffer.allocate(buf.remaining() + in.remaining()).setAutoExpand(<strong class="jxr_keyword">true</strong>); |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> newBuf.order(buf.order()); |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> newBuf.put(buf); |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> newBuf.put(in); |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> newBuf.flip(); |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> buf = newBuf; |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_comment">// Update the session attribute.</em> |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> session.setAttribute(BUFFER, buf); |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> } |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> buf = in; |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> usingSessionBuffer = false; |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> } |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">for</strong> (;;) { |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">int</strong> oldPos = buf.position(); |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">boolean</strong> decoded = doDecode(session, buf, out); |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">if</strong> (decoded) { |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">if</strong> (buf.position() == oldPos) { |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"doDecode() can't return true when buffer is not consumed."</span>); |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> } |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">if</strong> (!buf.hasRemaining()) { |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> } |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> } |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> } |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_comment">// if there is any data left that cannot be decoded, we store</em> |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <em class="jxr_comment">// it in a buffer in the session and next time this decoder is</em> |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_comment">// invoked the session buffer gets appended to</em> |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">if</strong> (buf.hasRemaining()) { |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">if</strong> (usingSessionBuffer && buf.isAutoExpand()) { |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> buf.compact(); |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> storeRemainingInSession(buf, session); |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> } |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">if</strong> (usingSessionBuffer) { |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> removeSessionBuffer(session); |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> } |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> } |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> } |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * Implement this method to consume the specified cumulative buffer and</em> |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * decode its content into message(s).</em> |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * @param session The current Session</em> |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * @param in the cumulative buffer</em> |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * @param out The {@link ProtocolDecoderOutput} that will receive the decoded message</em> |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * @return <tt>true</tt> if and only if there's more to decode in the buffer</em> |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * and you want to have <tt>doDecode</tt> method invoked again.</em> |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * Return <tt>false</tt> if remaining data is not enough to decode,</em> |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * then this method will be invoked again when more data is</em> |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * cumulated.</em> |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> * @throws Exception if cannot decode <tt>in</tt>.</em> |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> doDecode(<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 href="../../../../../org/apache/mina/filter/codec/ProtocolDecoderOutput.html">ProtocolDecoderOutput</a> out) <strong class="jxr_keyword">throws</strong> Exception; |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * Releases the cumulative buffer used by the specified <tt>session</tt>.</em> |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * Please don't forget to call <tt>super.dispose( session )</tt> when you</em> |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * override this method.</em> |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> @Override |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> dispose(<a href="../../../../../org/apache/mina/core/session/IoSession.html">IoSession</a> session) <strong class="jxr_keyword">throws</strong> Exception { |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> removeSessionBuffer(session); |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> } |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> removeSessionBuffer(<a href="../../../../../org/apache/mina/core/session/IoSession.html">IoSession</a> session) { |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> session.removeAttribute(BUFFER); |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> } |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> storeRemainingInSession(<a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> buf, <a href="../../../../../org/apache/mina/core/session/IoSession.html">IoSession</a> session) { |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> remainingBuf = IoBuffer.allocate(buf.capacity()).setAutoExpand(<strong class="jxr_keyword">true</strong>); |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> remainingBuf.order(buf.order()); |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> remainingBuf.put(buf); |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> session.setAttribute(BUFFER, remainingBuf); |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> } |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2016 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</div> |
| </body> |
| </html> |
