| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>FifoDeliveryQueue (Qpid ProtonJ2 Parent 1.0.0-M18 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.qpid.protonj2.client.util, class: FifoDeliveryQueue"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/FifoDeliveryQueue.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.client.util</a></div> |
| <h1 title="Class FifoDeliveryQueue" class="title">Class FifoDeliveryQueue</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.qpid.protonj2.client.util.FifoDeliveryQueue</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">FifoDeliveryQueue</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></span></div> |
| <div class="block">Simple first in / first out <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> Queue.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">FifoDeliveryQueue</a><wbr>(int queueDepth)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new first in / first out message queue with the given queue depth</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Clears the Queue of any queued <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Closes the Delivery Queue.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#dequeue(long)" class="member-name-link">dequeue</a><wbr>(long timeout)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Used to get an <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#dequeueNoWait()" class="member-name-link">dequeueNoWait</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Used to get an enqueued <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> if on exists, otherwise returns null.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enqueue(org.apache.qpid.protonj2.client.impl.ClientDelivery)" class="member-name-link">enqueue</a><wbr>(<a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a> envelope)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds the given <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> to the end of the Delivery queue.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enqueueFirst(org.apache.qpid.protonj2.client.impl.ClientDelivery)" class="member-name-link">enqueueFirst</a><wbr>(<a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a> envelope)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds the given <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> to the front of the queue.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isClosed()" class="member-name-link">isClosed</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRunning()" class="member-name-link">isRunning</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#size()" class="member-name-link">size</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of deliveries currently in the Queue.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start()" class="member-name-link">start</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Starts the Delivery Queue.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stop()" class="member-name-link">stop</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Stops the Delivery Queue.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(int)"> |
| <h3>FifoDeliveryQueue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FifoDeliveryQueue</span><wbr><span class="parameters">(int queueDepth)</span></div> |
| <div class="block">Creates a new first in / first out message queue with the given queue depth</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>queueDepth</code> - The Queue depth to configure for this FIFO Message Queue.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="enqueueFirst(org.apache.qpid.protonj2.client.impl.ClientDelivery)"> |
| <h3>enqueueFirst</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">enqueueFirst</span><wbr><span class="parameters">(<a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a> envelope)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DeliveryQueue.html#enqueueFirst(org.apache.qpid.protonj2.client.impl.ClientDelivery)">DeliveryQueue</a></code></span></div> |
| <div class="block">Adds the given <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> to the front of the queue.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DeliveryQueue.html#enqueueFirst(org.apache.qpid.protonj2.client.impl.ClientDelivery)">enqueueFirst</a></code> in interface <code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>envelope</code> - The in-bound Delivery to enqueue.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enqueue(org.apache.qpid.protonj2.client.impl.ClientDelivery)"> |
| <h3>enqueue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">enqueue</span><wbr><span class="parameters">(<a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a> envelope)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DeliveryQueue.html#enqueue(org.apache.qpid.protonj2.client.impl.ClientDelivery)">DeliveryQueue</a></code></span></div> |
| <div class="block">Adds the given <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> to the end of the Delivery queue.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DeliveryQueue.html#enqueue(org.apache.qpid.protonj2.client.impl.ClientDelivery)">enqueue</a></code> in interface <code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>envelope</code> - The in-bound Delivery to enqueue.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dequeue(long)"> |
| <h3>dequeue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a></span> <span class="element-name">dequeue</span><wbr><span class="parameters">(long timeout)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DeliveryQueue.html#dequeue(long)">DeliveryQueue</a></code></span></div> |
| <div class="block">Used to get an <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>. The amount of time this method blocks is based on the timeout value |
| that is supplied to it. |
| |
| <ul> |
| <li> |
| If the timeout value is less than zero the dequeue operation blocks until a Delivery |
| is enqueued or the queue is stopped. |
| </li> |
| <li> |
| If the timeout value is zero the dequeue operation will not block and will either return |
| the next Delivery on the Queue or null to indicate the queue is empty. |
| </li> |
| <li> |
| If the timeout value is greater than zero then the method will either return the next Delivery |
| in the queue or block until the timeout (in milliseconds) has expired or until a new Delivery |
| is placed onto the queue. |
| </li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DeliveryQueue.html#dequeue(long)">dequeue</a></code> in interface <code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>timeout</code> - The amount of time to wait for an entry to be added before returning null.</dd> |
| <dt>Returns:</dt> |
| <dd>null if we timeout or if the <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> is closed.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code> - if the wait is interrupted.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dequeueNoWait()"> |
| <h3>dequeueNoWait</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a></span> <span class="element-name">dequeueNoWait</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DeliveryQueue.html#dequeueNoWait()">DeliveryQueue</a></code></span></div> |
| <div class="block">Used to get an enqueued <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> if on exists, otherwise returns null.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DeliveryQueue.html#dequeueNoWait()">dequeueNoWait</a></code> in interface <code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the next Delivery in the Queue if one exists, otherwise null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="start()"> |
| <h3>start</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">start</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DeliveryQueue.html#start()">DeliveryQueue</a></code></span></div> |
| <div class="block">Starts the Delivery Queue. An non-started Queue will always return null for |
| any of the Queue methods.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DeliveryQueue.html#start()">start</a></code> in interface <code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stop()"> |
| <h3>stop</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">stop</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DeliveryQueue.html#stop()">DeliveryQueue</a></code></span></div> |
| <div class="block">Stops the Delivery Queue. Deliveries cannot be read from the Queue when it is in |
| the stopped state and any waiters will be woken.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DeliveryQueue.html#stop()">stop</a></code> in interface <code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DeliveryQueue.html#close()">DeliveryQueue</a></code></span></div> |
| <div class="block">Closes the Delivery Queue. No Delivery can be added or removed from the Queue |
| once it has entered the closed state.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DeliveryQueue.html#close()">close</a></code> in interface <code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRunning()"> |
| <h3>isRunning</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRunning</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DeliveryQueue.html#isRunning()">isRunning</a></code> in interface <code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if the Queue is not in the stopped or closed state.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isClosed()"> |
| <h3>isClosed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isClosed</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DeliveryQueue.html#isClosed()">isClosed</a></code> in interface <code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if the Queue has been closed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEmpty()"> |
| <h3>isEmpty</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DeliveryQueue.html#isEmpty()">isEmpty</a></code> in interface <code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if there are no deliveries in the queue.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="size()"> |
| <h3>size</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">size</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DeliveryQueue.html#size()">DeliveryQueue</a></code></span></div> |
| <div class="block">Returns the number of deliveries currently in the Queue. This value is only |
| meaningful at the time of the call as the size of the Queue changes rapidly |
| as deliveries arrive and are consumed.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DeliveryQueue.html#size()">size</a></code> in interface <code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the current number of <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> objects in the Queue.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="DeliveryQueue.html#clear()">DeliveryQueue</a></code></span></div> |
| <div class="block">Clears the Queue of any queued <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> values.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DeliveryQueue.html#clear()">clear</a></code> in interface <code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
