blob: 372b7d3b852233c2746637e15c88c585dc1034f0 [file] [log] [blame]
<!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 Sat Mar 16 18:07:13 CET 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractPollingIoProcessor (Apache MINA 2.0.0-M1 API Documentation)</title>
<meta name="date" content="2019-03-16">
<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="AbstractPollingIoProcessor (Apache MINA 2.0.0-M1 API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":6,"i2":6,"i3":10,"i4":6,"i5":10,"i6":6,"i7":10,"i8":10,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":10,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":10,"i22":6,"i23":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AbstractPollingIoProcessor.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/common/AbstractPollingIoConnector.ConnectionRequest.html" title="class in org.apache.mina.common"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.SessionState.html" title="enum in org.apache.mina.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/common/AbstractPollingIoProcessor.html" target="_top">Frames</a></li>
<li><a href="AbstractPollingIoProcessor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.common</div>
<h2 title="Class AbstractPollingIoProcessor" class="title">Class AbstractPollingIoProcessor&lt;T extends <a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.mina.common.AbstractPollingIoProcessor&lt;T&gt;</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/common/IoProcessor.html" title="interface in org.apache.mina.common">IoProcessor</a>&lt;T&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><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/NioProcessor.html" title="class in org.apache.mina.transport.socket.nio">NioProcessor</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractPollingIoProcessor&lt;T extends <a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&gt;</span>
extends java.lang.Object
implements <a href="../../../../org/apache/mina/common/IoProcessor.html" title="interface in org.apache.mina.common">IoProcessor</a>&lt;T&gt;</pre>
<div class="block">An abstract implementation of <a href="../../../../org/apache/mina/common/IoProcessor.html" title="interface in org.apache.mina.common"><code>IoProcessor</code></a> which helps
transport developers to write an <a href="../../../../org/apache/mina/common/IoProcessor.html" title="interface in org.apache.mina.common"><code>IoProcessor</code></a> easily.</div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Rev: 627803 $, $Date: 2008-02-14 18:03:14 +0100 (Thu, 14 Feb 2008) $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>The Apache MINA Project (dev@mina.apache.org)</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">&nbsp;</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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.SessionState.html" title="enum in org.apache.mina.common">AbstractPollingIoProcessor.SessionState</a></span></code>&nbsp;</td>
</tr>
</table>
</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#AbstractPollingIoProcessor-java.util.concurrent.Executor-">AbstractPollingIoProcessor</a></span>(java.util.concurrent.Executor&nbsp;executor)</code>&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#add-T-">add</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;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 id="i1" class="rowColor">
<td class="colFirst"><code>protected abstract java.util.Iterator&lt;<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#allSessions--">allSessions</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#destroy-T-">destroy</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#dispose--">dispose</a></span>()</code>
<div class="block">Releases any resources allocated by this processor.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#dispose0--">dispose0</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#flush-T-">flush</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</code>
<div class="block">Flushes the internal write request queue of the specified
<code>session</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#init-T-">init</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#isDisposed--">isDisposed</a></span>()</code>
<div class="block">Returns <tt>true</tt> if and if only all resources of this processor
have been disposed.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#isDisposing--">isDisposing</a></span>()</code>
<div class="block">Returns <tt>true</tt> if and if only <a href="../../../../org/apache/mina/common/IoProcessor.html#dispose--"><code>IoProcessor.dispose()</code></a> method has
been called.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#isInterestedInRead-T-">isInterestedInRead</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</code>
<div class="block">is this session registered for reading</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#isInterestedInWrite-T-">isInterestedInWrite</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</code>
<div class="block">is this session registered for writing</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#isReadable-T-">isReadable</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</code>
<div class="block">Is the session ready for reading</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#isWritable-T-">isWritable</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</code>
<div class="block">Is the session ready for writing</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#read-T-org.apache.mina.common.IoBuffer-">read</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session,
<a href="../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common">IoBuffer</a>&nbsp;buf)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#remove-T-">remove</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;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 id="i15" class="rowColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#select-int-">select</a></span>(int&nbsp;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 abstract java.util.Iterator&lt;<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#selectedSessions--">selectedSessions</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#setInterestedInRead-T-boolean-">setInterestedInRead</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session,
boolean&nbsp;interested)</code>
<div class="block">register a session for reading</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#setInterestedInWrite-T-boolean-">setInterestedInWrite</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session,
boolean&nbsp;interested)</code>
<div class="block">register a session for writing</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>protected abstract <a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.SessionState.html" title="enum in org.apache.mina.common">AbstractPollingIoProcessor.SessionState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#state-T-">state</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>protected abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#transferFile-T-org.apache.mina.common.FileRegion-int-">transferFile</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session,
<a href="../../../../org/apache/mina/common/FileRegion.html" title="interface in org.apache.mina.common">FileRegion</a>&nbsp;region,
int&nbsp;length)</code>&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#updateTrafficMask-T-">updateTrafficMask</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</code>
<div class="block">Controls the traffic of the specified <code>session</code> as specified
in <a href="../../../../org/apache/mina/common/IoSession.html#getTrafficMask--"><code>IoSession.getTrafficMask()</code></a>.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>protected abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#wakeup--">wakeup</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>protected abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html#write-T-org.apache.mina.common.IoBuffer-int-">write</a></span>(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session,
<a href="../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common">IoBuffer</a>&nbsp;buf,
int&nbsp;length)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="AbstractPollingIoProcessor-java.util.concurrent.Executor-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractPollingIoProcessor</h4>
<pre>protected&nbsp;AbstractPollingIoProcessor(java.util.concurrent.Executor&nbsp;executor)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ 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>public final&nbsp;boolean&nbsp;isDisposing()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html#isDisposing--">IoProcessor</a></code></span></div>
<div class="block">Returns <tt>true</tt> if and if only <a href="../../../../org/apache/mina/common/IoProcessor.html#dispose--"><code>IoProcessor.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.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/mina/common/IoProcessor.html#isDisposing--">isDisposing</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html" title="interface in org.apache.mina.common">IoProcessor</a>&lt;<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a> extends <a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="isDisposed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDisposed</h4>
<pre>public final&nbsp;boolean&nbsp;isDisposed()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html#isDisposed--">IoProcessor</a></code></span></div>
<div class="block">Returns <tt>true</tt> if and if only all resources of this processor
have been disposed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/mina/common/IoProcessor.html#isDisposed--">isDisposed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html" title="interface in org.apache.mina.common">IoProcessor</a>&lt;<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a> extends <a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="dispose--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispose</h4>
<pre>public final&nbsp;void&nbsp;dispose()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html#dispose--">IoProcessor</a></code></span></div>
<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>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/mina/common/IoProcessor.html#dispose--">dispose</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html" title="interface in org.apache.mina.common">IoProcessor</a>&lt;<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a> extends <a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="dispose0--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispose0</h4>
<pre>protected abstract&nbsp;void&nbsp;dispose0()
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="select-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>select</h4>
<pre>protected abstract&nbsp;boolean&nbsp;select(int&nbsp;timeout)
throws java.lang.Exception</pre>
<div class="block">poll those sessions for the given timeout</div>
<dl>
<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>true if at least a session is ready for read or for write</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if some low level IO error occurs</dd>
</dl>
</li>
</ul>
<a name="wakeup--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wakeup</h4>
<pre>protected abstract&nbsp;void&nbsp;wakeup()</pre>
</li>
</ul>
<a name="allSessions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allSessions</h4>
<pre>protected abstract&nbsp;java.util.Iterator&lt;<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&gt;&nbsp;allSessions()</pre>
</li>
</ul>
<a name="selectedSessions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectedSessions</h4>
<pre>protected abstract&nbsp;java.util.Iterator&lt;<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&gt;&nbsp;selectedSessions()</pre>
</li>
</ul>
<a name="state-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a><a name="state-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>state</h4>
<pre>protected abstract&nbsp;<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.SessionState.html" title="enum in org.apache.mina.common">AbstractPollingIoProcessor.SessionState</a>&nbsp;state(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</pre>
</li>
</ul>
<a name="isWritable-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a><a name="isWritable-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWritable</h4>
<pre>protected abstract&nbsp;boolean&nbsp;isWritable(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</pre>
<div class="block">Is the session ready for writing</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the session queried</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true is ready, false if not ready</dd>
</dl>
</li>
</ul>
<a name="isReadable-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a><a name="isReadable-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReadable</h4>
<pre>protected abstract&nbsp;boolean&nbsp;isReadable(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</pre>
<div class="block">Is the session ready for reading</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the session queried</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true is ready, false if not ready</dd>
</dl>
</li>
</ul>
<a name="setInterestedInWrite-org.apache.mina.common.AbstractIoSession-boolean-">
<!-- -->
</a><a name="setInterestedInWrite-T-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInterestedInWrite</h4>
<pre>protected abstract&nbsp;void&nbsp;setInterestedInWrite(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session,
boolean&nbsp;interested)
throws java.lang.Exception</pre>
<div class="block">register a session for writing</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the session registered</dd>
<dd><code>interested</code> - true for registering, false for removing</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="setInterestedInRead-org.apache.mina.common.AbstractIoSession-boolean-">
<!-- -->
</a><a name="setInterestedInRead-T-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInterestedInRead</h4>
<pre>protected abstract&nbsp;void&nbsp;setInterestedInRead(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session,
boolean&nbsp;interested)
throws java.lang.Exception</pre>
<div class="block">register a session for reading</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the session registered</dd>
<dd><code>interested</code> - true for registering, false for removing</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="isInterestedInRead-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a><a name="isInterestedInRead-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInterestedInRead</h4>
<pre>protected abstract&nbsp;boolean&nbsp;isInterestedInRead(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</pre>
<div class="block">is this session registered for reading</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the session queried</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true is registered for reading</dd>
</dl>
</li>
</ul>
<a name="isInterestedInWrite-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a><a name="isInterestedInWrite-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInterestedInWrite</h4>
<pre>protected abstract&nbsp;boolean&nbsp;isInterestedInWrite(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</pre>
<div class="block">is this session registered for writing</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the session queried</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true is registered for writing</dd>
</dl>
</li>
</ul>
<a name="init-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a><a name="init-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>protected abstract&nbsp;void&nbsp;init(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="destroy-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a><a name="destroy-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroy</h4>
<pre>protected abstract&nbsp;void&nbsp;destroy(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="read-org.apache.mina.common.AbstractIoSession-org.apache.mina.common.IoBuffer-">
<!-- -->
</a><a name="read-T-org.apache.mina.common.IoBuffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>protected abstract&nbsp;int&nbsp;read(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session,
<a href="../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common">IoBuffer</a>&nbsp;buf)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="write-org.apache.mina.common.AbstractIoSession-org.apache.mina.common.IoBuffer-int-">
<!-- -->
</a><a name="write-T-org.apache.mina.common.IoBuffer-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>protected abstract&nbsp;int&nbsp;write(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session,
<a href="../../../../org/apache/mina/common/IoBuffer.html" title="class in org.apache.mina.common">IoBuffer</a>&nbsp;buf,
int&nbsp;length)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="transferFile-org.apache.mina.common.AbstractIoSession-org.apache.mina.common.FileRegion-int-">
<!-- -->
</a><a name="transferFile-T-org.apache.mina.common.FileRegion-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transferFile</h4>
<pre>protected abstract&nbsp;int&nbsp;transferFile(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session,
<a href="../../../../org/apache/mina/common/FileRegion.html" title="interface in org.apache.mina.common">FileRegion</a>&nbsp;region,
int&nbsp;length)
throws java.lang.Exception</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="add-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a><a name="add-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public final&nbsp;void&nbsp;add(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html#add-T-">IoProcessor</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/mina/common/IoProcessor.html#add-T-">add</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html" title="interface in org.apache.mina.common">IoProcessor</a>&lt;<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a> extends <a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="remove-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a><a name="remove-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public final&nbsp;void&nbsp;remove(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html#remove-T-">IoProcessor</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/mina/common/IoProcessor.html#remove-T-">remove</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html" title="interface in org.apache.mina.common">IoProcessor</a>&lt;<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a> extends <a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="flush-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a><a name="flush-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flush</h4>
<pre>public final&nbsp;void&nbsp;flush(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html#flush-T-">IoProcessor</a></code></span></div>
<div class="block">Flushes the internal write request queue of the specified
<code>session</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/mina/common/IoProcessor.html#flush-T-">flush</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html" title="interface in org.apache.mina.common">IoProcessor</a>&lt;<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a> extends <a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="updateTrafficMask-org.apache.mina.common.AbstractIoSession-">
<!-- -->
</a><a name="updateTrafficMask-T-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>updateTrafficMask</h4>
<pre>public final&nbsp;void&nbsp;updateTrafficMask(<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a>&nbsp;session)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html#updateTrafficMask-T-">IoProcessor</a></code></span></div>
<div class="block">Controls the traffic of the specified <code>session</code> as specified
in <a href="../../../../org/apache/mina/common/IoSession.html#getTrafficMask--"><code>IoSession.getTrafficMask()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/mina/common/IoProcessor.html#updateTrafficMask-T-">updateTrafficMask</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/mina/common/IoProcessor.html" title="interface in org.apache.mina.common">IoProcessor</a>&lt;<a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.html" title="type parameter in AbstractPollingIoProcessor">T</a> extends <a href="../../../../org/apache/mina/common/AbstractIoSession.html" title="class in org.apache.mina.common">AbstractIoSession</a>&gt;</code></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/AbstractPollingIoProcessor.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/common/AbstractPollingIoConnector.ConnectionRequest.html" title="class in org.apache.mina.common"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/mina/common/AbstractPollingIoProcessor.SessionState.html" title="enum in org.apache.mina.common"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/common/AbstractPollingIoProcessor.html" target="_top">Frames</a></li>
<li><a href="AbstractPollingIoProcessor.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p>
</body>
</html>