| <!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>FileRegion xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/mina/common/FileRegion.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.mina.common; |
| <a name="2" href="#2">2</a> |
| <a name="3" href="#3">3</a> <strong class="jxr_keyword">import</strong> java.nio.channels.FileChannel; |
| <a name="4" href="#4">4</a> |
| <a name="5" href="#5">5</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * Indicates the region of a file to be sent to the remote host.</em> |
| <a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * @author The Apache MINA Project (dev@mina.apache.org)</em> |
| <a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * @version $Rev: 560320 $, $Date: 2007-07-27 11:12:26 -0600 (Fri, 27 Jul 2007) $,</em> |
| <a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="11" href="#11">11</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/mina/common/FileRegion.html">FileRegion</a> { |
| <a name="12" href="#12">12</a> |
| <a name="13" href="#13">13</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * The open <tt>FileChannel<tt> from which data will be read to send to remote host.</em> |
| <a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * @return An open <tt>FileChannel<tt>.</em> |
| <a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="18" href="#18">18</a> FileChannel getFileChannel(); |
| <a name="19" href="#19">19</a> |
| <a name="20" href="#20">20</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="21" href="#21">21</a> <em class="jxr_javadoccomment"> * The current file position from which data will be read.</em> |
| <a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * @return The current file position.</em> |
| <a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">long</strong> getPosition(); |
| <a name="26" href="#26">26</a> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * Updates the current file position. May not be negative.</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @param value The new value for the file position.</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">void</strong> setPosition(<strong class="jxr_keyword">long</strong> value); |
| <a name="33" href="#33">33</a> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * The number of bytes to be written from the file to the remote host.</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @return The number of bytes to be written.</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="39" href="#39">39</a> <strong class="jxr_keyword">long</strong> getCount(); |
| <a name="40" href="#40">40</a> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * The total number of bytes already written.</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @return The total number of bytes already written.</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="46" href="#46">46</a> <strong class="jxr_keyword">long</strong> getWrittenBytes(); |
| <a name="47" href="#47">47</a> |
| <a name="48" href="#48">48</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
