| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 --> |
| <title>IQueueDequeue (Eclipse Communication Framework (ECF) 3.14.22 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <meta name="dc.created" content="2021-06-15"> |
| <meta name="description" content="declaration: package: org.eclipse.ecf.core.sharedobject.util, interface: IQueueDequeue"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IQueueDequeue.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-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <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> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.ecf.core.sharedobject.util</a></div> |
| <h1 title="Interface IQueueDequeue" class="title">Interface IQueueDequeue</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="IQueue.html" title="interface in org.eclipse.ecf.core.sharedobject.util">IQueue</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IQueueDequeue</span></pre> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#blocking_dequeue(int)">blocking_dequeue</a></span>​(int timeout_millis)</code></th> |
| <td class="colLast"> |
| <div class="block">Dequeue a single Event.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#blocking_dequeue(int,int)">blocking_dequeue</a></span>​(int timeout_millis, |
| int num)</code></th> |
| <td class="colLast"> |
| <div class="block">Dequeue a multiple Events.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#blocking_dequeue_all(int)">blocking_dequeue_all</a></span>​(int timeout_millis)</code></th> |
| <td class="colLast"> |
| <div class="block">Dequeue all Events currently on queue.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dequeue()">dequeue</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Dequeue a single event.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dequeue(int)">dequeue</a></span>​(int num)</code></th> |
| <td class="colLast"> |
| <div class="block">Dequeue several events in one operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dequeue_all()">dequeue_all</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Dequeue all available Events.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size()">size</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Provide the current size of the queue (the number of Events) currently on |
| the queue.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="dequeue()">dequeue</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a></span> <span class="memberName">dequeue</span>()</div> |
| <div class="block">Dequeue a single event. Returns null if no Events available for dequeue</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Event the Event dequeued. Null if queue is empty.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="dequeue(int)">dequeue</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[]</span> <span class="memberName">dequeue</span>​(<span class="arguments">int num)</span></div> |
| <div class="block">Dequeue several events in one operation. num events are dequeued.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Event[] the Events dequeue. Returns null if there are not |
| sufficient events on queue to support dequeuing num events</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="dequeue_all()">dequeue_all</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[]</span> <span class="memberName">dequeue_all</span>()</div> |
| <div class="block">Dequeue all available Events.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Event[] the events on this queue. Returns null if there are no |
| events in queue</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="blocking_dequeue(int)">blocking_dequeue</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a></span> <span class="memberName">blocking_dequeue</span>​(<span class="arguments">int timeout_millis)</span></div> |
| <div class="block">Dequeue a single Event. Blocks until an Event is available for dequeue, |
| or until timeout_millis have elapsed. If timeout_millis is -1, dequeue |
| does not timeout.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout_millis</code> - the timeout for a dequeue in milliseconds.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Event removed from queue. Returns null if no events on queue.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="blocking_dequeue(int,int)">blocking_dequeue</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[]</span> <span class="memberName">blocking_dequeue</span>​(<span class="arguments">int timeout_millis, |
| int num)</span></div> |
| <div class="block">Dequeue a multiple Events. Blocks until num Events are available for |
| dequeue, or until timeout_millis have elapsed. If timeout_millis is -1, |
| dequeue does not timeout.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout_millis</code> - the timeout for a dequeue in milliseconds.</dd> |
| <dd><code>num</code> - the number of Events to dequeue</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Event [] the num Events removed from queue</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="blocking_dequeue_all(int)">blocking_dequeue_all</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../../util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a>[]</span> <span class="memberName">blocking_dequeue_all</span>​(<span class="arguments">int timeout_millis)</span></div> |
| <div class="block">Dequeue all Events currently on queue. Blocks until num Events are |
| available for dequeue, or until timeout_millis have elapsed. If |
| timeout_millis is -1, dequeue does not timeout.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout_millis</code> - the timeout for a dequeue in milliseconds.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Event [] the num Events removed from queue</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="size()">size</a></h3> |
| <div class="memberSignature"><span class="returnType">int</span> <span class="memberName">size</span>()</div> |
| <div class="block">Provide the current size of the queue (the number of Events) currently on |
| the queue.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>size the int size of the queue</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IQueueDequeue.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-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <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> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
