| <!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>Selector (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="Selector (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}; |
| 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/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/qpid/proton/reactor/Task.html" title="interface in org.apache.qpid.proton.reactor"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/qpid/proton/reactor/Selector.html" target="_top">Frames</a></li> |
| <li><a href="Selector.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.qpid.proton.reactor</div> |
| <h2 title="Interface Selector" class="title">Interface Selector</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Selector</span></pre> |
| <div class="block">A multiplexor of instances of <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor"><code>Selectable</code></a>. |
| <p> |
| Many instances of <code>Selectable</code> can be added to a selector, and |
| the <a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#select-long-"><code>select(long)</code></a> method used to block the calling thread until |
| one of the <code>Selectables</code> becomes read to perform an operation. |
| <p> |
| This class is not thread safe, so only one thread should be manipulating the |
| contents of the selector, or running the <a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#select-long-"><code>select(long)</code></a> method at |
| any given time.</div> |
| </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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#add-org.apache.qpid.proton.reactor.Selectable-">add</a></span>(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a> selectable)</code> |
| <div class="block">Adds a selectable to the selector.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#error--">error</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#expired--">expired</a></span>()</code> </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/qpid/proton/reactor/Selector.html#free--">free</a></span>()</code> |
| <div class="block">Frees the resources used by this selector.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#readable--">readable</a></span>()</code> </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/qpid/proton/reactor/Selector.html#remove-org.apache.qpid.proton.reactor.Selectable-">remove</a></span>(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a> selectable)</code> |
| <div class="block">Removes a selectable from the selector.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#select-long-">select</a></span>(long timeout)</code> |
| <div class="block">Waits for the specified timeout period for one or more selectables to |
| become ready for an operation.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#update-org.apache.qpid.proton.reactor.Selectable-">update</a></span>(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a> selectable)</code> |
| <div class="block">Updates the selector to reflect any changes interest by the specified |
| selectable.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#writeable--">writeable</a></span>()</code> </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="add-org.apache.qpid.proton.reactor.Selectable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre>void add(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a> selectable) |
| throws java.io.IOException</pre> |
| <div class="block">Adds a selectable to the selector.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>selectable</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="update-org.apache.qpid.proton.reactor.Selectable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>void update(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a> selectable)</pre> |
| <div class="block">Updates the selector to reflect any changes interest by the specified |
| selectable. This is achieved by calling the |
| <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#isReading--"><code>Selectable.isReading()</code></a> and <a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html#isWriting--"><code>Selectable.isWriting()</code></a> |
| methods.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>selectable</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="remove-org.apache.qpid.proton.reactor.Selectable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre>void remove(<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a> selectable)</pre> |
| <div class="block">Removes a selectable from the selector.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>selectable</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="select-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre>void select(long timeout) |
| throws java.io.IOException</pre> |
| <div class="block">Waits for the specified timeout period for one or more selectables to |
| become ready for an operation. Selectables that become ready are |
| returned by the <a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#readable--"><code>readable()</code></a>, <a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#writeable--"><code>writeable()</code></a>, |
| <a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#expired--"><code>expired()</code></a>, or <a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#error--"><code>error()</code></a> methods.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - the maximum number of milliseconds to block the calling |
| thread waiting for a selectable to become ready for an |
| operation. The value zero is interpreted as check but |
| don't block.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readable</h4> |
| <pre>java.util.Iterator<<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a>> readable()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the selectables that have become readable since the last call |
| to <a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#select-long-"><code>select(long)</code></a>. Calling <code>select</code> clears |
| any previous values in this set before adding new values |
| corresponding to those selectables that have become readable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeable</h4> |
| <pre>java.util.Iterator<<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a>> writeable()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the selectables that have become writable since the last call |
| to <a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#select-long-"><code>select(long)</code></a>. Calling <code>select</code> clears |
| any previous values in this set before adding new values |
| corresponding to those selectables that have become writable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="expired--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>expired</h4> |
| <pre>java.util.Iterator<<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a>> expired()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the selectables that have expired since the last call |
| to <a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#select-long-"><code>select(long)</code></a>. Calling <code>select</code> clears |
| any previous values in this set before adding new values |
| corresponding to those selectables that have now expired.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="error--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>error</h4> |
| <pre>java.util.Iterator<<a href="../../../../../org/apache/qpid/proton/reactor/Selectable.html" title="interface in org.apache.qpid.proton.reactor">Selectable</a>> error()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the selectables that have encountered an error since the last |
| call to <a href="../../../../../org/apache/qpid/proton/reactor/Selector.html#select-long-"><code>select(long)</code></a>. Calling <code>select</code> |
| clears any previous values in this set before adding new values |
| corresponding to those selectables that have encountered an |
| error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="free--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>free</h4> |
| <pre>void free()</pre> |
| <div class="block">Frees the resources used by this selector.</div> |
| </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/Selectable.Callback.html" title="interface in org.apache.qpid.proton.reactor"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/qpid/proton/reactor/Task.html" title="interface in org.apache.qpid.proton.reactor"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/qpid/proton/reactor/Selector.html" target="_top">Frames</a></li> |
| <li><a href="Selector.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 ======= --> |
| </body> |
| </html> |
