| <!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_US" lang="en_US"> |
| <head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| <title>FileRegionWriteFilter xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/mina/filter/stream/FileRegionWriteFilter.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.stream; |
| <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> java.io.IOException; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.buffer.IoBuffer; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.mina.core.file.FileRegion; |
| <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"> * Filter implementation that converts a {@link FileRegion} to {@link IoBuffer}</em> |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * objects and writes those buffers to the next filter. When end of the</em> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * {@code FileRegion} has been reached this filter will call</em> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * {@link IoFilter.NextFilter#messageSent(IoSession,WriteRequest)} using the</em> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * original {@link FileRegion} written to the session and notifies</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * {@link org.apache.mina.core.future.WriteFuture} on the original</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * {@link org.apache.mina.core.write.WriteRequest}.</em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * <p>Normall {@code FileRegion} objects should be handled by the</em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * {@link org.apache.mina.core.service.IoProcessor} but this is not always possible</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * if a filter is being used that needs to modify the contents of the file</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * before sending over the network (i.e. the</em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * {@link org.apache.mina.filter.ssl.SslFilter} or a data compression filter.)</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * <p> This filter will ignore written messages which aren't {@link FileRegion}</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * instances. Such messages will be passed to the next filter directly.</em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * <p><b>NOTE:</b> this filter does not close the file channel in</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * {@link FileRegion#getFileChannel()} after the data from the file has been</em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * written. The {@code FileChannel} should be closed in either </em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * {@link org.apache.mina.core.service.IoHandler#messageSent(IoSession,Object)}</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * or in an {@link org.apache.mina.core.future.IoFutureListener} associated with the</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * {@code WriteFuture}.</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * </p></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"> * @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="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * @org.apache.xbean.XBean</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/mina/filter/stream/FileRegionWriteFilter.html">FileRegionWriteFilter</a> <strong class="jxr_keyword">extends</strong> AbstractStreamWriteFilter<FileRegion> { |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> @Override |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">protected</strong> Class<FileRegion> getMessageClass() { |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">return</strong> FileRegion.<strong class="jxr_keyword">class</strong>; |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> } |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> @Override |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> getNextBuffer(<a href="../../../../../org/apache/mina/core/file/FileRegion.html">FileRegion</a> fileRegion) <strong class="jxr_keyword">throws</strong> IOException { |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_comment">// If there are no more bytes to read, return null</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">if</strong> (fileRegion.getRemainingBytes() <= 0) { |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> } |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_comment">// Allocate the buffer for reading from the file</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bufferSize = (<strong class="jxr_keyword">int</strong>) Math.min(getWriteBufferSize(), fileRegion.getRemainingBytes()); |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <a href="../../../../../org/apache/mina/core/buffer/IoBuffer.html">IoBuffer</a> buffer = IoBuffer.allocate(bufferSize); |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_comment">// Read from the file</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">int</strong> bytesRead = fileRegion.getFileChannel().read(buffer.buf(), fileRegion.getPosition()); |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> fileRegion.update(bytesRead); |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_comment">// return the buffer</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> buffer.flip(); |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">return</strong> buffer; |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> } |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2004–2014 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</div> |
| </body> |
| </html> |
