blob: 0d363cb26c2d7691b5b67ecc86dd3b5eecd54fbf [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 -->
<title>Selectable (Qpid Proton-J API)</title>
<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="Selectable (Qpid Proton-J API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="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/qpid/proton/reactor/ReactorOptions.html" title="class in org.apache.qpid.proton.reactor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/qpid/proton/reactor/Selectable.html" target="_top">Frames</a></li>
<li><a href="Selectable.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>Constr&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>Constr&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.qpid.proton.reactor</div>
<h2 title="Interface Selectable" class="title">Interface Selectable</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a>, <a href="../../../../../org/apache/qpid/proton/reactor/ReactorChild.html" title="interface in org.apache.qpid.proton.reactor">ReactorChild</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/qpid/proton/reactor/impl/SelectableImpl.html" title="class in org.apache.qpid.proton.reactor.impl">SelectableImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Selectable</span>
extends <a href="../../../../../org/apache/qpid/proton/reactor/ReactorChild.html" title="interface in org.apache.qpid.proton.reactor">ReactorChild</a>, <a href="../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a></pre>
<div class="block">An entity that can be multiplexed using a <a href="../../../../../org/apache/qpid/proton/reactor/Selector.html" title="interface in org.apache.qpid.proton.reactor"><code>Selector</code></a>.
<p>
Every selectable is associated with exactly one <code>SelectableChannel</code>.
Selectables may be interested in three kinds of events: read events, write
events, and timer events. A selectable will express its interest in these
events through the <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#isReading--"><code>isReading()</code></a>, <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#isWriting--"><code>isWriting()</code></a>, and
<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#getDeadline--"><code>getDeadline()</code></a> methods.
<p>
When a read, write, or timer event occurs, the selectable must be notified by
calling <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#readable--"><code>readable()</code></a>, <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#writeable--"><code>writeable()</code></a>, or <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#expired--"><code>expired()</code></a> as
appropriate.
Once a selectable reaches a terminal state (see <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#isTerminal--"><code>isTerminal()</code></a>, it
will never be interested in events of any kind. When this occurs it should be
removed from the Selector and discarded using <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#free--"><code>free()</code></a>.</div>
</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">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a></span></code>
<div class="block">A callback that can be passed to the various "on" methods of the
selectable - to allow code to be run when the selectable becomes ready
for the associated operation.</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">&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></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/qpid/proton/reactor/Selectable.html#error--">error</a></span>()</code>
<div class="block">Notify the selectable that an error has occurred.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#expired--">expired</a></span>()</code>
<div class="block">Notify the selectable that it has expired.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#free--">free</a></span>()</code>
<div class="block">Notify the selectable that it has been free'd.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.nio.channels.SelectableChannel</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#getChannel--">getChannel</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#getDeadline--">getDeadline</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/reactor/Reactor.html" title="interface in org.apache.qpid.proton.reactor">Reactor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#getReactor--">getReactor</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#isReading--">isReading</a></span>()</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/qpid/proton/reactor/Selectable.html#isRegistered--">isRegistered</a></span>()</code>
<div class="block">Check if a selectable is registered.</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/qpid/proton/reactor/Selectable.html#isTerminal--">isTerminal</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#isWriting--">isWriting</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#onError-org.apache.qpid.proton.reactor.Selectable.Callback-">onError</a></span>(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a>&nbsp;runnable)</code>
<div class="block">Registers a callback that will be run when the selectable is notified of
an error.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#onExpired-org.apache.qpid.proton.reactor.Selectable.Callback-">onExpired</a></span>(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a>&nbsp;runnable)</code>
<div class="block">Registers a callback that will be run when the selectable expires.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#onFree-org.apache.qpid.proton.reactor.Selectable.Callback-">onFree</a></span>(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a>&nbsp;runnable)</code>
<div class="block">Registers a callback that will be run when the selectable is notified
that it has been free'd.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#onReadable-org.apache.qpid.proton.reactor.Selectable.Callback-">onReadable</a></span>(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a>&nbsp;runnable)</code>
<div class="block">Registers a callback that will be run when the selectable becomes ready
for reading.</div>
</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/qpid/proton/reactor/Selectable.html#onRelease-org.apache.qpid.proton.reactor.Selectable.Callback-">onRelease</a></span>(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a>&nbsp;runnable)</code>
<div class="block">Registers a callback that will be run when the selectable is notified
that it has been released.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#onWritable-org.apache.qpid.proton.reactor.Selectable.Callback-">onWritable</a></span>(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a>&nbsp;runnable)</code>
<div class="block">Registers a callback that will be run when the selectable becomes ready
for writing.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#readable--">readable</a></span>()</code>
<div class="block">Notify the selectable that the underlying <code>SelectableChannel</code> is
ready for a read operation.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#release--">release</a></span>()</code>
<div class="block">Notify the selectable that it has been released.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#setChannel-java.nio.channels.SelectableChannel-">setChannel</a></span>(java.nio.channels.SelectableChannel&nbsp;channel)</code>
<div class="block">Associates a <code>SelectableChannel</code> with this selector.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#setCollector-org.apache.qpid.proton.engine.Collector-">setCollector</a></span>(<a href="../../../../../org/apache/qpid/proton/engine/Collector.html" title="interface in org.apache.qpid.proton.engine">Collector</a>&nbsp;collector)</code>
<div class="block">Configure a selectable with a set of callbacks that emit readable,
writable, and expired events into the supplied collector.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#setDeadline-long-">setDeadline</a></span>(long&nbsp;deadline)</code>
<div class="block">Sets the value that will be returned by <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#getDeadline--"><code>getDeadline()</code></a>.</div>
</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/qpid/proton/reactor/Selectable.html#setReading-boolean-">setReading</a></span>(boolean&nbsp;reading)</code>
<div class="block">Sets the value that will be returned by <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#isReading--"><code>isReading()</code></a>.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#setRegistered-boolean-">setRegistered</a></span>(boolean&nbsp;registered)</code>
<div class="block">Set the registered flag for a selectable.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#setWriting-boolean-">setWriting</a></span>(boolean&nbsp;writing)</code>
<div class="block">Sets the value that will be returned by <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#isWriting--"><code>isWriting()</code></a>.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#terminate--">terminate</a></span>()</code>
<div class="block">Terminates the selectable.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#writeable--">writeable</a></span>()</code>
<div class="block">Notify the selectable that the underlying <code>SelectableChannel</code> is
ready for a write operation.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.Extendable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.proton.engine.<a href="../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a></h3>
<code><a href="../../../../../org/apache/qpid/proton/engine/Extendable.html#attachments--">attachments</a></code></li>
</ul>
</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="isReading--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReading</h4>
<pre>boolean&nbsp;isReading()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the selectable is interested in receiving
notification (via the <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#readable--"><code>readable()</code></a> method that indicate
that the associated <code>SelectableChannel</code> has data ready
to be read from it.</dd>
</dl>
</li>
</ul>
<a name="isWriting--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWriting</h4>
<pre>boolean&nbsp;isWriting()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the selectable is interested in receiving
notifications (via the <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#writeable--"><code>writeable()</code></a> method that indicate
that the associated <code>SelectableChannel</code> is ready to be
written to.</dd>
</dl>
</li>
</ul>
<a name="getDeadline--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeadline</h4>
<pre>long&nbsp;getDeadline()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a deadline after which this selectable can expect to receive
a notification (via the <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#expired--"><code>expired()</code></a> method that indicates
that the deadline has past. The deadline is expressed in the
same format as <code>System.currentTimeMillis()</code>. Returning
a deadline of zero (or a negative number) indicates that the
selectable does not wish to be notified of expiry.</dd>
</dl>
</li>
</ul>
<a name="setReading-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReading</h4>
<pre>void&nbsp;setReading(boolean&nbsp;reading)</pre>
<div class="block">Sets the value that will be returned by <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#isReading--"><code>isReading()</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reading</code> - </dd>
</dl>
</li>
</ul>
<a name="setWriting-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWriting</h4>
<pre>void&nbsp;setWriting(boolean&nbsp;writing)</pre>
<div class="block">Sets the value that will be returned by <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#isWriting--"><code>isWriting()</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>writing</code> - </dd>
</dl>
</li>
</ul>
<a name="setDeadline-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDeadline</h4>
<pre>void&nbsp;setDeadline(long&nbsp;deadline)</pre>
<div class="block">Sets the value that will be returned by <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#getDeadline--"><code>getDeadline()</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deadline</code> - </dd>
</dl>
</li>
</ul>
<a name="onReadable-org.apache.qpid.proton.reactor.Selectable.Callback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onReadable</h4>
<pre>void&nbsp;onReadable(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a>&nbsp;runnable)</pre>
<div class="block">Registers a callback that will be run when the selectable becomes ready
for reading.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>runnable</code> - the callback to register. Any previously registered
callback will be replaced.</dd>
</dl>
</li>
</ul>
<a name="onWritable-org.apache.qpid.proton.reactor.Selectable.Callback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onWritable</h4>
<pre>void&nbsp;onWritable(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a>&nbsp;runnable)</pre>
<div class="block">Registers a callback that will be run when the selectable becomes ready
for writing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>runnable</code> - the callback to register. Any previously registered
callback will be replaced.</dd>
</dl>
</li>
</ul>
<a name="onExpired-org.apache.qpid.proton.reactor.Selectable.Callback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onExpired</h4>
<pre>void&nbsp;onExpired(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a>&nbsp;runnable)</pre>
<div class="block">Registers a callback that will be run when the selectable expires.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>runnable</code> - the callback to register. Any previously registered
callback will be replaced.</dd>
</dl>
</li>
</ul>
<a name="onError-org.apache.qpid.proton.reactor.Selectable.Callback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onError</h4>
<pre>void&nbsp;onError(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a>&nbsp;runnable)</pre>
<div class="block">Registers a callback that will be run when the selectable is notified of
an error.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>runnable</code> - the callback to register. Any previously registered
callback will be replaced.</dd>
</dl>
</li>
</ul>
<a name="onRelease-org.apache.qpid.proton.reactor.Selectable.Callback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onRelease</h4>
<pre>void&nbsp;onRelease(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a>&nbsp;runnable)</pre>
<div class="block">Registers a callback that will be run when the selectable is notified
that it has been released.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>runnable</code> - the callback to register. Any previously registered
callback will be replaced.</dd>
</dl>
</li>
</ul>
<a name="onFree-org.apache.qpid.proton.reactor.Selectable.Callback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onFree</h4>
<pre>void&nbsp;onFree(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor">Selectable.Callback</a>&nbsp;runnable)</pre>
<div class="block">Registers a callback that will be run when the selectable is notified
that it has been free'd.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>runnable</code> - the callback to register. Any previously registered
callback will be replaced.</dd>
</dl>
</li>
</ul>
<a name="readable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readable</h4>
<pre>void&nbsp;readable()</pre>
<div class="block">Notify the selectable that the underlying <code>SelectableChannel</code> is
ready for a read operation.</div>
</li>
</ul>
<a name="writeable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeable</h4>
<pre>void&nbsp;writeable()</pre>
<div class="block">Notify the selectable that the underlying <code>SelectableChannel</code> is
ready for a write operation.</div>
</li>
</ul>
<a name="expired--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>expired</h4>
<pre>void&nbsp;expired()</pre>
<div class="block">Notify the selectable that it has expired.</div>
</li>
</ul>
<a name="error--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>error</h4>
<pre>void&nbsp;error()</pre>
<div class="block">Notify the selectable that an error has occurred.</div>
</li>
</ul>
<a name="release--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>release</h4>
<pre>void&nbsp;release()</pre>
<div class="block">Notify the selectable that it has been released.</div>
</li>
</ul>
<a name="free--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>free</h4>
<pre>void&nbsp;free()</pre>
<div class="block">Notify the selectable that it has been free'd.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/qpid/proton/reactor/ReactorChild.html#free--">free</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/qpid/proton/reactor/ReactorChild.html" title="interface in org.apache.qpid.proton.reactor">ReactorChild</a></code></dd>
</dl>
</li>
</ul>
<a name="setChannel-java.nio.channels.SelectableChannel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChannel</h4>
<pre>void&nbsp;setChannel(java.nio.channels.SelectableChannel&nbsp;channel)</pre>
<div class="block">Associates a <code>SelectableChannel</code> with this selector.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>channel</code> - </dd>
</dl>
</li>
</ul>
<a name="getChannel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChannel</h4>
<pre>java.nio.channels.SelectableChannel&nbsp;getChannel()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>SelectableChannel</code> associated with this selector.</dd>
</dl>
</li>
</ul>
<a name="isRegistered--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRegistered</h4>
<pre>boolean&nbsp;isRegistered()</pre>
<div class="block">Check if a selectable is registered. This can be used for tracking
whether a given selectable has been registerd with an external event
loop.
<p>
<em>Note:</em> the reactor code, currently, does not use this flag.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code>if the selectable is registered.</dd>
</dl>
</li>
</ul>
<a name="setRegistered-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRegistered</h4>
<pre>void&nbsp;setRegistered(boolean&nbsp;registered)</pre>
<div class="block">Set the registered flag for a selectable.
<p>
<em>Note:</em> the reactor code, currently, does not use this flag.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>registered</code> - the value returned by <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#isRegistered--"><code>isRegistered()</code></a></dd>
</dl>
</li>
</ul>
<a name="setCollector-org.apache.qpid.proton.engine.Collector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCollector</h4>
<pre>void&nbsp;setCollector(<a href="../../../../../org/apache/qpid/proton/engine/Collector.html" title="interface in org.apache.qpid.proton.engine">Collector</a>&nbsp;collector)</pre>
<div class="block">Configure a selectable with a set of callbacks that emit readable,
writable, and expired events into the supplied collector.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>collector</code> - </dd>
</dl>
</li>
</ul>
<a name="getReactor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReactor</h4>
<pre><a href="../../../../../org/apache/qpid/proton/reactor/Reactor.html" title="interface in org.apache.qpid.proton.reactor">Reactor</a>&nbsp;getReactor()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the reactor to which this selectable is a child.</dd>
</dl>
</li>
</ul>
<a name="terminate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>terminate</h4>
<pre>void&nbsp;terminate()</pre>
<div class="block">Terminates the selectable. Once a selectable reaches a terminal state
it will never be interested in events of any kind.</div>
</li>
</ul>
<a name="isTerminal--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isTerminal</h4>
<pre>boolean&nbsp;isTerminal()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the selectable has reached a terminal state.</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="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/qpid/proton/reactor/ReactorOptions.html" title="class in org.apache.qpid.proton.reactor"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/qpid/proton/reactor/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/qpid/proton/reactor/Selectable.html" target="_top">Frames</a></li>
<li><a href="Selectable.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>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>