| <!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 (version 1.7.0_55) on Thu Aug 25 11:37:31 CEST 2016 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>IoProcessor (Apache MINA 2.0.14 API)</title> |
| <meta name="date" content="2016-08-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IoProcessor (Apache MINA 2.0.14 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/IoProcessor.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/core/service/IoHandlerAdapter.html" title="class in org.apache.mina.core.service"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/mina/core/service/IoService.html" title="interface in org.apache.mina.core.service"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/core/service/IoProcessor.html" target="_top">Frames</a></li> |
| <li><a href="IoProcessor.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.core.service</div> |
| <h2 title="Interface IoProcessor" class="title">Interface IoProcessor<S extends <a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - the type of the <a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> this processor can handle</dd></dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><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/apr/AprIoProcessor.html" title="class in org.apache.mina.transport.socket.apr">AprIoProcessor</a>, <a href="../../../../../org/apache/mina/transport/socket/nio/NioDatagramAcceptor.html" title="class in org.apache.mina.transport.socket.nio">NioDatagramAcceptor</a>, <a href="../../../../../org/apache/mina/transport/socket/nio/NioProcessor.html" title="class in org.apache.mina.transport.socket.nio">NioProcessor</a>, <a href="../../../../../org/apache/mina/core/service/SimpleIoProcessorPool.html" title="class in org.apache.mina.core.service">SimpleIoProcessorPool</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../src-html/org/apache/mina/core/service/IoProcessor.html#line.35">IoProcessor</a><S extends <a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a>></pre> |
| <div class="block">An internal interface to represent an 'I/O processor' that performs |
| actual I/O operations for <a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a>s. It abstracts existing |
| reactor frameworks such as Java NIO once again to simplify transport |
| implementations.</div> |
| <dl><dt><span class="strong">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"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/core/service/IoProcessor.html#add(S)">add</a></strong>(<a href="../../../../../org/apache/mina/core/service/IoProcessor.html" title="type parameter in IoProcessor">S</a> session)</code> |
| <div class="block">Adds the specified <code>session</code> to the I/O processor so that |
| the I/O processor starts to perform any I/O operations related |
| with the <code>session</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/core/service/IoProcessor.html#dispose()">dispose</a></strong>()</code> |
| <div class="block">Releases any resources allocated by this processor.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/core/service/IoProcessor.html#flush(S)">flush</a></strong>(<a href="../../../../../org/apache/mina/core/service/IoProcessor.html" title="type parameter in IoProcessor">S</a> session)</code> |
| <div class="block">Flushes the internal write request queue of the specified |
| <code>session</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/core/service/IoProcessor.html#isDisposed()">isDisposed</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/core/service/IoProcessor.html#isDisposing()">isDisposing</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/core/service/IoProcessor.html#remove(S)">remove</a></strong>(<a href="../../../../../org/apache/mina/core/service/IoProcessor.html" title="type parameter in IoProcessor">S</a> session)</code> |
| <div class="block">Removes and closes the specified <code>session</code> from the I/O |
| processor so that the I/O processor closes the connection |
| associated with the <code>session</code> and releases any other related |
| resources.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/core/service/IoProcessor.html#updateTrafficControl(S)">updateTrafficControl</a></strong>(<a href="../../../../../org/apache/mina/core/service/IoProcessor.html" title="type parameter in IoProcessor">S</a> session)</code> |
| <div class="block">Controls the traffic of the specified <code>session</code> depending of the |
| <a href="../../../../../org/apache/mina/core/session/IoSession.html#isReadSuspended()"><code>IoSession.isReadSuspended()</code></a> and <a href="../../../../../org/apache/mina/core/session/IoSession.html#isWriteSuspended()"><code>IoSession.isWriteSuspended()</code></a> |
| flags</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/mina/core/service/IoProcessor.html#write(S, org.apache.mina.core.write.WriteRequest)">write</a></strong>(<a href="../../../../../org/apache/mina/core/service/IoProcessor.html" title="type parameter in IoProcessor">S</a> session, |
| <a href="../../../../../org/apache/mina/core/write/WriteRequest.html" title="interface in org.apache.mina.core.write">WriteRequest</a> writeRequest)</code> |
| <div class="block">Writes the WriteRequest for the specified <code>session</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isDisposing()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDisposing</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/mina/core/service/IoProcessor.html#line.42">isDisposing</a>()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if and if only <a href="../../../../../org/apache/mina/core/service/IoProcessor.html#dispose()"><code>dispose()</code></a> method has |
| been called. Please note that this method will return <tt>true</tt> |
| even after all the related resources are released.</dd></dl> |
| </li> |
| </ul> |
| <a name="isDisposed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDisposed</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/mina/core/service/IoProcessor.html#line.48">isDisposed</a>()</pre> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if and if only all resources of this processor |
| have been disposed.</dd></dl> |
| </li> |
| </ul> |
| <a name="dispose()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dispose</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/mina/core/service/IoProcessor.html#line.56">dispose</a>()</pre> |
| <div class="block">Releases any resources allocated by this processor. Please note that |
| the resources might not be released as long as there are any sessions |
| managed by this processor. Most implementations will close all sessions |
| immediately and release the related resources.</div> |
| </li> |
| </ul> |
| <a name="add(org.apache.mina.core.session.IoSession)"> |
| <!-- --> |
| </a><a name="add(S)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/mina/core/service/IoProcessor.html#line.65">add</a>(<a href="../../../../../org/apache/mina/core/service/IoProcessor.html" title="type parameter in IoProcessor">S</a> session)</pre> |
| <div class="block">Adds the specified <code>session</code> to the I/O processor so that |
| the I/O processor starts to perform any I/O operations related |
| with the <code>session</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - The added session</dd></dl> |
| </li> |
| </ul> |
| <a name="flush(org.apache.mina.core.session.IoSession)"> |
| <!-- --> |
| </a><a name="flush(S)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flush</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/mina/core/service/IoProcessor.html#line.73">flush</a>(<a href="../../../../../org/apache/mina/core/service/IoProcessor.html" title="type parameter in IoProcessor">S</a> session)</pre> |
| <div class="block">Flushes the internal write request queue of the specified |
| <code>session</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - The session we want the message to be written</dd></dl> |
| </li> |
| </ul> |
| <a name="write(org.apache.mina.core.session.IoSession,org.apache.mina.core.write.WriteRequest)"> |
| <!-- --> |
| </a><a name="write(S, org.apache.mina.core.write.WriteRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/mina/core/service/IoProcessor.html#line.81">write</a>(<a href="../../../../../org/apache/mina/core/service/IoProcessor.html" title="type parameter in IoProcessor">S</a> session, |
| <a href="../../../../../org/apache/mina/core/write/WriteRequest.html" title="interface in org.apache.mina.core.write">WriteRequest</a> writeRequest)</pre> |
| <div class="block">Writes the WriteRequest for the specified <code>session</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - The session we want the message to be written</dd><dd><code>writeRequest</code> - the WriteRequest to write</dd></dl> |
| </li> |
| </ul> |
| <a name="updateTrafficControl(org.apache.mina.core.session.IoSession)"> |
| <!-- --> |
| </a><a name="updateTrafficControl(S)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateTrafficControl</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/mina/core/service/IoProcessor.html#line.90">updateTrafficControl</a>(<a href="../../../../../org/apache/mina/core/service/IoProcessor.html" title="type parameter in IoProcessor">S</a> session)</pre> |
| <div class="block">Controls the traffic of the specified <code>session</code> depending of the |
| <a href="../../../../../org/apache/mina/core/session/IoSession.html#isReadSuspended()"><code>IoSession.isReadSuspended()</code></a> and <a href="../../../../../org/apache/mina/core/session/IoSession.html#isWriteSuspended()"><code>IoSession.isWriteSuspended()</code></a> |
| flags</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - The session to be updated</dd></dl> |
| </li> |
| </ul> |
| <a name="remove(org.apache.mina.core.session.IoSession)"> |
| <!-- --> |
| </a><a name="remove(S)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/mina/core/service/IoProcessor.html#line.100">remove</a>(<a href="../../../../../org/apache/mina/core/service/IoProcessor.html" title="type parameter in IoProcessor">S</a> session)</pre> |
| <div class="block">Removes and closes the specified <code>session</code> from the I/O |
| processor so that the I/O processor closes the connection |
| associated with the <code>session</code> and releases any other related |
| resources.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - The session to be removed</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/IoProcessor.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/core/service/IoHandlerAdapter.html" title="class in org.apache.mina.core.service"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/mina/core/service/IoService.html" title="interface in org.apache.mina.core.service"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/core/service/IoProcessor.html" target="_top">Frames</a></li> |
| <li><a href="IoProcessor.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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–2016 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |