blob: fb54e9e84734e036c444ba46085e9eb7e0446232 [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>StreamWriteFilter xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/mina/filter/stream/StreamWriteFilter.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.filter.stream;
<a name="21" href="#21">21</a>
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
<a name="24" href="#24">24</a>
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.buffer.IoBuffer;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.filterchain.IoFilter;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.session.IoSession;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.write.WriteRequest;
<a name="29" href="#29">29</a>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * Filter implementation which makes it possible to write {@link InputStream}</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * objects directly using {@link IoSession#write(Object)}. When an</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * {@link InputStream} is written to a session this filter will read the bytes</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * from the stream into {@link IoBuffer} objects and write those buffers</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * to the next filter. When end of stream has been reached this filter will</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * call {@link IoFilter.NextFilter#messageSent(IoSession,WriteRequest)} using the original</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * {@link InputStream} written to the session and notifies</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * {@link org.apache.mina.core.future.WriteFuture} on the</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * original {@link org.apache.mina.core.write.WriteRequest}.</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * This filter will ignore written messages which aren't {@link InputStream}</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * instances. Such messages will be passed to the next filter directly.</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * NOTE: this filter does not close the stream after all data from stream</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * has been written. The {@link org.apache.mina.core.service.IoHandler} should take</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * care of that in its</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * {@link org.apache.mina.core.service.IoHandler#messageSent(IoSession,Object)}</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * callback.</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> *</em>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @author The Apache MINA Project (dev@mina.apache.org)</em>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @version $Rev: 671827 $, $Date: 2008-06-26 10:49:48 +0200 (jeu, 26 jun 2008) $</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> */</em>
<a name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/mina/filter/stream/StreamWriteFilter.html">StreamWriteFilter</a> <strong class="jxr_keyword">extends</strong> AbstractStreamWriteFilter&lt;InputStream&gt; {
<a name="56" href="#56">56</a>
<a name="57" href="#57">57</a> @Override
<a name="58" href="#58">58</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> getNextBuffer(InputStream is) <strong class="jxr_keyword">throws</strong> IOException {
<a name="59" href="#59">59</a> byte[] bytes = <strong class="jxr_keyword">new</strong> byte[getWriteBufferSize()];
<a name="60" href="#60">60</a>
<a name="61" href="#61">61</a> <strong class="jxr_keyword">int</strong> off = 0;
<a name="62" href="#62">62</a> <strong class="jxr_keyword">int</strong> n = 0;
<a name="63" href="#63">63</a> <strong class="jxr_keyword">while</strong> (off &lt; bytes.length
<a name="64" href="#64">64</a> &amp;&amp; (n = is.read(bytes, off, bytes.length - off)) != -1) {
<a name="65" href="#65">65</a> off += n;
<a name="66" href="#66">66</a> }
<a name="67" href="#67">67</a>
<a name="68" href="#68">68</a> <strong class="jxr_keyword">if</strong> (n == -1 &amp;&amp; off == 0) {
<a name="69" href="#69">69</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="70" href="#70">70</a> }
<a name="71" href="#71">71</a>
<a name="72" href="#72">72</a> <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> buffer = IoBuffer.wrap(bytes, 0, off);
<a name="73" href="#73">73</a>
<a name="74" href="#74">74</a> <strong class="jxr_keyword">return</strong> buffer;
<a name="75" href="#75">75</a> }
<a name="76" href="#76">76</a>
<a name="77" href="#77">77</a> @Override
<a name="78" href="#78">78</a> <strong class="jxr_keyword">protected</strong> Class&lt;InputStream&gt; getMessageClass() {
<a name="79" href="#79">79</a> <strong class="jxr_keyword">return</strong> InputStream.<strong class="jxr_keyword">class</strong>;
<a name="80" href="#80">80</a> }
<a name="81" href="#81">81</a>
<a name="82" href="#82">82</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>