| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_191) on Wed May 29 12:25:10 CEST 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>NioProcessor (Apache MINA 2.1.3 API Documentation)</title> |
| <meta name="date" content="2019-05-29"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="NioProcessor (Apache MINA 2.1.3 API Documentation)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NioProcessor.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/mina/transport/socket/nio/NioDatagramConnector.html" title="class in org.apache.mina.transport.socket.nio"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.IoSessionIterator.html" title="class in org.apache.mina.transport.socket.nio"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mina/transport/socket/nio/NioProcessor.html" target="_top">Frames</a></li> |
| <li><a href="NioProcessor.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.mina.core.polling.AbstractPollingIoProcessor">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.mina.transport.socket.nio</div> |
| <h2 title="Class NioProcessor" class="title">Class NioProcessor</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">org.apache.mina.core.polling.AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mina.transport.socket.nio.NioProcessor</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/mina/core/service/IoProcessor.html" title="interface in org.apache.mina.core.service">IoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">NioProcessor</span> |
| extends <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></pre> |
| <div class="block">A processor for incoming and outgoing data get and written on a TCP socket.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="http://mina.apache.org">Apache MINA Project</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.IoSessionIterator.html" title="class in org.apache.mina.transport.socket.nio">NioProcessor.IoSessionIterator</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.IoSessionIterator.html" title="type parameter in NioProcessor.IoSessionIterator">NioSession</a>></span></code> |
| <div class="block">An encapsulating iterator around the <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/nio/channels/Selector.html?is-external=true#selectedKeys--" title="class or interface in java.nio.channels"><code>Selector.selectedKeys()</code></a> or |
| the <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/nio/channels/Selector.html?is-external=true#keys--" title="class or interface in java.nio.channels"><code>Selector.keys()</code></a> iterator;</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.mina.core.polling.AbstractPollingIoProcessor"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.mina.core.polling.<a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a></h3> |
| <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#wakeupCalled">wakeupCalled</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#NioProcessor-java.util.concurrent.Executor-">NioProcessor</a></span>(<a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a> executor)</code> |
| <div class="block">Creates a new instance of NioProcessor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#NioProcessor-java.util.concurrent.Executor-java.nio.channels.spi.SelectorProvider-">NioProcessor</a></span>(<a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a> executor, |
| <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/nio/channels/spi/SelectorProvider.html?is-external=true" title="class or interface in java.nio.channels.spi">SelectorProvider</a> selectorProvider)</code> |
| <div class="block">Creates a new instance of NioProcessor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#allSessions--">allSessions</a></span>()</code> |
| <div class="block">Get an <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> for the list of <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> polled by this |
| <a href="../../../../../../org/apache/mina/core/service/IoProcessor.html" title="interface in org.apache.mina.core.service"><code>IoProcessor</code></a></div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#allSessionsCount--">allSessionsCount</a></span>()</code> |
| <div class="block">Get the number of <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> polled by this <a href="../../../../../../org/apache/mina/core/service/IoProcessor.html" title="interface in org.apache.mina.core.service"><code>IoProcessor</code></a></div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#destroy-org.apache.mina.transport.socket.nio.NioSession-">destroy</a></span>(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session)</code> |
| <div class="block">Destroy the underlying client socket handle</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#doDispose--">doDispose</a></span>()</code> |
| <div class="block">Dispose the resources used by this <a href="../../../../../../org/apache/mina/core/service/IoProcessor.html" title="interface in org.apache.mina.core.service"><code>IoProcessor</code></a> for polling the |
| client connections.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/mina/core/session/SessionState.html" title="enum in org.apache.mina.core.session">SessionState</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#getState-org.apache.mina.transport.socket.nio.NioSession-">getState</a></span>(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session)</code> |
| <div class="block">Get the state of a session (One of OPENING, OPEN, CLOSING)</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#init-org.apache.mina.transport.socket.nio.NioSession-">init</a></span>(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session)</code> |
| <div class="block">Initialize the polling of a session.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#isBrokenConnection--">isBrokenConnection</a></span>()</code> |
| <div class="block">Check that the select() has not exited immediately just because of a |
| broken connection.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#isInterestedInRead-org.apache.mina.transport.socket.nio.NioSession-">isInterestedInRead</a></span>(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session)</code> |
| <div class="block">Tells if this session is registered for reading</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#isInterestedInWrite-org.apache.mina.transport.socket.nio.NioSession-">isInterestedInWrite</a></span>(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session)</code> |
| <div class="block">Tells if this session is registered for writing</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#isReadable-org.apache.mina.transport.socket.nio.NioSession-">isReadable</a></span>(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session)</code> |
| <div class="block">Tells if the session ready for reading</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#isSelectorEmpty--">isSelectorEmpty</a></span>()</code> |
| <div class="block">Say if the list of <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> polled by this <a href="../../../../../../org/apache/mina/core/service/IoProcessor.html" title="interface in org.apache.mina.core.service"><code>IoProcessor</code></a> |
| is empty</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#isWritable-org.apache.mina.transport.socket.nio.NioSession-">isWritable</a></span>(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session)</code> |
| <div class="block">Tells if the session ready for writing</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#read-org.apache.mina.transport.socket.nio.NioSession-org.apache.mina.core.buffer.IoBuffer-">read</a></span>(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session, |
| <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> buf)</code> |
| <div class="block">Reads a sequence of bytes from a <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> into the given |
| <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer"><code>IoBuffer</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#registerNewSelector--">registerNewSelector</a></span>()</code> |
| <div class="block">In the case we are using the java select() method, this method is used to |
| trash the buggy selector and create a new one, registering all the |
| sockets on it.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#select--">select</a></span>()</code> |
| <div class="block">poll those sessions forever</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#select-long-">select</a></span>(long timeout)</code> |
| <div class="block">poll those sessions for the given timeout</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#selectedSessions--">selectedSessions</a></span>()</code> |
| <div class="block">Get an <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> for the list of <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> found selected |
| by the last call of <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#select-long-"><code>AbstractPollingIoProcessor.select(long)</code></a></div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#setInterestedInRead-org.apache.mina.transport.socket.nio.NioSession-boolean-">setInterestedInRead</a></span>(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session, |
| boolean isInterested)</code> |
| <div class="block">Set the session to be informed when a read event should be processed</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#setInterestedInWrite-org.apache.mina.transport.socket.nio.NioSession-boolean-">setInterestedInWrite</a></span>(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session, |
| boolean isInterested)</code> |
| <div class="block">Set the session to be informed when a write event should be processed</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#transferFile-org.apache.mina.transport.socket.nio.NioSession-org.apache.mina.core.file.FileRegion-int-">transferFile</a></span>(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session, |
| <a href="../../../../../../org/apache/mina/core/file/FileRegion.html" title="interface in org.apache.mina.core.file">FileRegion</a> region, |
| int length)</code> |
| <div class="block">Write a part of a file to a <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a>, if the underlying API |
| isn't supporting system calls like sendfile(), you can throw a |
| <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a> so the file will be send using |
| usual <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#write-S-org.apache.mina.core.buffer.IoBuffer-int-"><code>AbstractPollingIoProcessor.write(AbstractIoSession, IoBuffer, int)</code></a> call.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#wakeup--">wakeup</a></span>()</code> |
| <div class="block">Interrupt the <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#select-long-"><code>AbstractPollingIoProcessor.select(long)</code></a> call.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html#write-org.apache.mina.transport.socket.nio.NioSession-org.apache.mina.core.buffer.IoBuffer-int-">write</a></span>(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session, |
| <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> buf, |
| int length)</code> |
| <div class="block">Write a sequence of bytes to a <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a>, means to be called when |
| a session was found ready for writing.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.core.polling.AbstractPollingIoProcessor"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.mina.core.polling.<a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a></h3> |
| <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#add-S-">add</a>, <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#dispose--">dispose</a>, <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#flush-S-">flush</a>, <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isDisposed--">isDisposed</a>, <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isDisposing--">isDisposing</a>, <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#remove-S-">remove</a>, <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#updateTrafficControl-S-">updateTrafficControl</a>, <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#updateTrafficMask-S-">updateTrafficMask</a>, <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#write-S-org.apache.mina.core.write.WriteRequest-">write</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="NioProcessor-java.util.concurrent.Executor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NioProcessor</h4> |
| <pre>public NioProcessor(<a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a> executor)</pre> |
| <div class="block">Creates a new instance of NioProcessor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executor</code> - The executor to use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="NioProcessor-java.util.concurrent.Executor-java.nio.channels.spi.SelectorProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NioProcessor</h4> |
| <pre>public NioProcessor(<a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a> executor, |
| <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/nio/channels/spi/SelectorProvider.html?is-external=true" title="class or interface in java.nio.channels.spi">SelectorProvider</a> selectorProvider)</pre> |
| <div class="block">Creates a new instance of NioProcessor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executor</code> - The executor to use</dd> |
| <dd><code>selectorProvider</code> - The Selector provider to use</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="doDispose--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doDispose</h4> |
| <pre>protected void doDispose() |
| throws <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#doDispose--">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Dispose the resources used by this <a href="../../../../../../org/apache/mina/core/service/IoProcessor.html" title="interface in org.apache.mina.core.service"><code>IoProcessor</code></a> for polling the |
| client connections. The implementing class doDispose method will be |
| called.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#doDispose--">doDispose</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if some low level IO error occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="select-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre>protected int select(long timeout) |
| throws <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#select-long-">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">poll those sessions for the given timeout</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#select-long-">select</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - milliseconds before the call timeout if no event appear</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The number of session ready for read or for write</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if some low level IO error occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="select--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre>protected int select() |
| throws <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#select--">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">poll those sessions forever</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#select--">select</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The number of session ready for read or for write</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if some low level IO error occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSelectorEmpty--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSelectorEmpty</h4> |
| <pre>protected boolean isSelectorEmpty()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isSelectorEmpty--">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Say if the list of <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> polled by this <a href="../../../../../../org/apache/mina/core/service/IoProcessor.html" title="interface in org.apache.mina.core.service"><code>IoProcessor</code></a> |
| is empty</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isSelectorEmpty--">isSelectorEmpty</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> if at least a session is managed by this |
| <a href="../../../../../../org/apache/mina/core/service/IoProcessor.html" title="interface in org.apache.mina.core.service"><code>IoProcessor</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="wakeup--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>wakeup</h4> |
| <pre>protected void wakeup()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#wakeup--">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Interrupt the <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#select-long-"><code>AbstractPollingIoProcessor.select(long)</code></a> call.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#wakeup--">wakeup</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allSessions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allSessions</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>> allSessions()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#allSessions--">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Get an <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> for the list of <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> polled by this |
| <a href="../../../../../../org/apache/mina/core/service/IoProcessor.html" title="interface in org.apache.mina.core.service"><code>IoProcessor</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#allSessions--">allSessions</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> of <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="allSessionsCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>allSessionsCount</h4> |
| <pre>protected int allSessionsCount()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#allSessionsCount--">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Get the number of <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> polled by this <a href="../../../../../../org/apache/mina/core/service/IoProcessor.html" title="interface in org.apache.mina.core.service"><code>IoProcessor</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#allSessionsCount--">allSessionsCount</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of sessions attached to this <a href="../../../../../../org/apache/mina/core/service/IoProcessor.html" title="interface in org.apache.mina.core.service"><code>IoProcessor</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="selectedSessions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectedSessions</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>> selectedSessions()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#selectedSessions--">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Get an <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> for the list of <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> found selected |
| by the last call of <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#select-long-"><code>AbstractPollingIoProcessor.select(long)</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#selectedSessions--">selectedSessions</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> of <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> read for I/Os operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="init-org.apache.mina.transport.socket.nio.NioSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>protected void init(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session) |
| throws <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#init-S-">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Initialize the polling of a session. Add it to the polling process.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#init-S-">init</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> to add to the polling</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - any exception thrown by the underlying system calls</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="destroy-org.apache.mina.transport.socket.nio.NioSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre>protected void destroy(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session) |
| throws <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#destroy-S-">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Destroy the underlying client socket handle</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#destroy-S-">destroy</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - any exception thrown by the underlying system calls</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerNewSelector--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerNewSelector</h4> |
| <pre>protected void registerNewSelector() |
| throws <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">In the case we are using the java select() method, this method is used to |
| trash the buggy selector and create a new one, registering all the |
| sockets on it.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#registerNewSelector--">registerNewSelector</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If we got an exception</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isBrokenConnection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isBrokenConnection</h4> |
| <pre>protected boolean isBrokenConnection() |
| throws <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Check that the select() has not exited immediately just because of a |
| broken connection. In this case, this is a standard case, and we just |
| have to loop.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isBrokenConnection--">isBrokenConnection</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> if a connection has been brutally closed.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If we got an exception</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getState-org.apache.mina.transport.socket.nio.NioSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre>protected <a href="../../../../../../org/apache/mina/core/session/SessionState.html" title="enum in org.apache.mina.core.session">SessionState</a> getState(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session)</pre> |
| <div class="block">Get the state of a session (One of OPENING, OPEN, CLOSING)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#getState-S-">getState</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> to inspect</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the state of the session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isReadable-org.apache.mina.transport.socket.nio.NioSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReadable</h4> |
| <pre>protected boolean isReadable(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isReadable-S-">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Tells if the session ready for reading</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isReadable-S-">isReadable</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the queried session</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> is ready, <tt>false</tt> if not ready</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isWritable-org.apache.mina.transport.socket.nio.NioSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isWritable</h4> |
| <pre>protected boolean isWritable(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isWritable-S-">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Tells if the session ready for writing</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isWritable-S-">isWritable</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the queried session</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> is ready, <tt>false</tt> if not ready</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isInterestedInRead-org.apache.mina.transport.socket.nio.NioSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInterestedInRead</h4> |
| <pre>protected boolean isInterestedInRead(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isInterestedInRead-S-">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Tells if this session is registered for reading</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isInterestedInRead-S-">isInterestedInRead</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the queried session</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> is registered for reading</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isInterestedInWrite-org.apache.mina.transport.socket.nio.NioSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isInterestedInWrite</h4> |
| <pre>protected boolean isInterestedInWrite(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isInterestedInWrite-S-">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Tells if this session is registered for writing</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#isInterestedInWrite-S-">isInterestedInWrite</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the queried session</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> is registered for writing</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInterestedInRead-org.apache.mina.transport.socket.nio.NioSession-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInterestedInRead</h4> |
| <pre>protected void setInterestedInRead(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session, |
| boolean isInterested) |
| throws <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Set the session to be informed when a read event should be processed</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#setInterestedInRead-S-boolean-">setInterestedInRead</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session for which we want to be interested in read events</dd> |
| <dd><code>isInterested</code> - <tt>true</tt> for registering, <tt>false</tt> for removing</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - If there was a problem while registering the session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInterestedInWrite-org.apache.mina.transport.socket.nio.NioSession-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInterestedInWrite</h4> |
| <pre>protected void setInterestedInWrite(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session, |
| boolean isInterested) |
| throws <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block">Set the session to be informed when a write event should be processed</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#setInterestedInWrite-S-boolean-">setInterestedInWrite</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session for which we want to be interested in write events</dd> |
| <dd><code>isInterested</code> - <tt>true</tt> for registering, <tt>false</tt> for removing</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - If there was a problem while registering the session</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="read-org.apache.mina.transport.socket.nio.NioSession-org.apache.mina.core.buffer.IoBuffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>read</h4> |
| <pre>protected int read(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session, |
| <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> buf) |
| throws <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#read-S-org.apache.mina.core.buffer.IoBuffer-">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Reads a sequence of bytes from a <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> into the given |
| <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer"><code>IoBuffer</code></a>. Is called when the session was found ready for reading.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#read-S-org.apache.mina.core.buffer.IoBuffer-">read</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session to read</dd> |
| <dd><code>buf</code> - the buffer to fill</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bytes read</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - any exception thrown by the underlying system calls</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="write-org.apache.mina.transport.socket.nio.NioSession-org.apache.mina.core.buffer.IoBuffer-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>protected int write(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session, |
| <a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a> buf, |
| int length) |
| throws <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#write-S-org.apache.mina.core.buffer.IoBuffer-int-">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Write a sequence of bytes to a <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a>, means to be called when |
| a session was found ready for writing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#write-S-org.apache.mina.core.buffer.IoBuffer-int-">write</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session to write</dd> |
| <dd><code>buf</code> - the buffer to write</dd> |
| <dd><code>length</code> - the number of bytes to write can be superior to the number of |
| bytes remaining in the buffer</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of byte written</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - any exception thrown by the underlying system calls</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="transferFile-org.apache.mina.transport.socket.nio.NioSession-org.apache.mina.core.file.FileRegion-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>transferFile</h4> |
| <pre>protected int transferFile(<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a> session, |
| <a href="../../../../../../org/apache/mina/core/file/FileRegion.html" title="interface in org.apache.mina.core.file">FileRegion</a> region, |
| int length) |
| throws <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#transferFile-S-org.apache.mina.core.file.FileRegion-int-">AbstractPollingIoProcessor</a></code></span></div> |
| <div class="block">Write a part of a file to a <a href="../../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a>, if the underlying API |
| isn't supporting system calls like sendfile(), you can throw a |
| <a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a> so the file will be send using |
| usual <a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#write-S-org.apache.mina.core.buffer.IoBuffer-int-"><code>AbstractPollingIoProcessor.write(AbstractIoSession, IoBuffer, int)</code></a> call.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html#transferFile-S-org.apache.mina.core.file.FileRegion-int-">transferFile</a></code> in class <code><a href="../../../../../../org/apache/mina/core/polling/AbstractPollingIoProcessor.html" title="class in org.apache.mina.core.polling">AbstractPollingIoProcessor</a><<a href="../../../../../../org/apache/mina/transport/socket/nio/NioSession.html" title="class in org.apache.mina.transport.socket.nio">NioSession</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session to write</dd> |
| <dd><code>region</code> - the file region to write</dd> |
| <dd><code>length</code> - the length of the portion to send</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of written bytes</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - any exception thrown by the underlying system calls</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/NioProcessor.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/mina/transport/socket/nio/NioDatagramConnector.html" title="class in org.apache.mina.transport.socket.nio"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/mina/transport/socket/nio/NioProcessor.IoSessionIterator.html" title="class in org.apache.mina.transport.socket.nio"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/mina/transport/socket/nio/NioProcessor.html" target="_top">Frames</a></li> |
| <li><a href="NioProcessor.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.mina.core.polling.AbstractPollingIoProcessor">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004–2019 <a href="https://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |