Google Git
Sign in
apache / qpid-site / a52bbf4a24b0bdf923763f81d78481d22102177f / . / input / releases / qpid-protonj2-1.0.0-M9 / api / org / apache / qpid / protonj2 / client / util / FifoDeliveryQueue.html
blob: 2530d2ccaac7eda18f0942c2815d06ef4d45cf06 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>FifoDeliveryQueue (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<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="FifoDeliveryQueue (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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/FifoDeliveryQueue.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="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.client.util</a></div>
<h2 title="Class FifoDeliveryQueue" class="title">Class FifoDeliveryQueue</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.client.util.FifoDeliveryQueue</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<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>
<pre>public final class <span class="typeNameLabel">FifoDeliveryQueue</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></pre>
<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>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int)">FifoDeliveryQueue</a></span>&#8203;(int&nbsp;queueDepth)</code></th>
<td class="colLast">
<div class="block">Creates a new first in / first out message queue with the given queue depth</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Closes the Delivery Queue.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dequeue(long)">dequeue</a></span>&#8203;(long&nbsp;timeout)</code></th>
<td class="colLast">
<div class="block">Used to get an <a href="../Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dequeueNoWait()">dequeueNoWait</a></span>()</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enqueue(org.apache.qpid.protonj2.client.impl.ClientDelivery)">enqueue</a></span>&#8203;(<a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a>&nbsp;envelope)</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enqueueFirst(org.apache.qpid.protonj2.client.impl.ClientDelivery)">enqueueFirst</a></span>&#8203;(<a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a>&nbsp;envelope)</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isClosed()">isClosed</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmpty()">isEmpty</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRunning()">isRunning</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<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">Returns the number of deliveries currently in the Queue.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start()">start</a></span>()</code></th>
<td class="colLast">
<div class="block">Starts the Delivery Queue.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stop()">stop</a></span>()</code></th>
<td class="colLast">
<div class="block">Stops the Delivery Queue.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FifoDeliveryQueue</h4>
<pre>public&nbsp;FifoDeliveryQueue&#8203;(int&nbsp;queueDepth)</pre>
<div class="block">Creates a new first in / first out message queue with the given queue depth</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queueDepth</code> - The Queue depth to configure for this FIFO Message Queue.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="enqueueFirst(org.apache.qpid.protonj2.client.impl.ClientDelivery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enqueueFirst</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;enqueueFirst&#8203;(<a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a>&nbsp;envelope)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DeliveryQueue.html#enqueueFirst(org.apache.qpid.protonj2.client.impl.ClientDelivery)">enqueueFirst</a></code>&nbsp;in interface&nbsp;<code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>envelope</code> - The in-bound Delivery to enqueue.</dd>
</dl>
</li>
</ul>
<a id="enqueue(org.apache.qpid.protonj2.client.impl.ClientDelivery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enqueue</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;enqueue&#8203;(<a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a>&nbsp;envelope)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DeliveryQueue.html#enqueue(org.apache.qpid.protonj2.client.impl.ClientDelivery)">enqueue</a></code>&nbsp;in interface&nbsp;<code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>envelope</code> - The in-bound Delivery to enqueue.</dd>
</dl>
</li>
</ul>
<a id="dequeue(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dequeue</h4>
<pre class="methodSignature">public&nbsp;<a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a>&nbsp;dequeue&#8203;(long&nbsp;timeout)
throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">InterruptedException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DeliveryQueue.html#dequeue(long)">dequeue</a></code>&nbsp;in interface&nbsp;<code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - The amount of time to wait for an entry to be added before returning null.</dd>
<dt><span class="returnLabel">Returns:</span></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><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang" class="externalLink">InterruptedException</a></code> - if the wait is interrupted.</dd>
</dl>
</li>
</ul>
<a id="dequeueNoWait()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dequeueNoWait</h4>
<pre class="methodSignature">public&nbsp;<a href="../impl/ClientDelivery.html" title="class in org.apache.qpid.protonj2.client.impl">ClientDelivery</a>&nbsp;dequeueNoWait()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DeliveryQueue.html#dequeueNoWait()">dequeueNoWait</a></code>&nbsp;in interface&nbsp;<code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next Delivery in the Queue if one exists, otherwise null.</dd>
</dl>
</li>
</ul>
<a id="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;start()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DeliveryQueue.html#start()">start</a></code>&nbsp;in interface&nbsp;<code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd>
</dl>
</li>
</ul>
<a id="stop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;stop()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DeliveryQueue.html#stop()">stop</a></code>&nbsp;in interface&nbsp;<code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DeliveryQueue.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd>
</dl>
</li>
</ul>
<a id="isRunning()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRunning</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRunning()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DeliveryQueue.html#isRunning()">isRunning</a></code>&nbsp;in interface&nbsp;<code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the Queue is not in the stopped or closed state.</dd>
</dl>
</li>
</ul>
<a id="isClosed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClosed</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isClosed()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DeliveryQueue.html#isClosed()">isClosed</a></code>&nbsp;in interface&nbsp;<code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the Queue has been closed.</dd>
</dl>
</li>
</ul>
<a id="isEmpty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isEmpty()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DeliveryQueue.html#isEmpty()">isEmpty</a></code>&nbsp;in interface&nbsp;<code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if there are no deliveries in the queue.</dd>
</dl>
</li>
</ul>
<a id="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;size()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DeliveryQueue.html#size()">size</a></code>&nbsp;in interface&nbsp;<code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd>
<dt><span class="returnLabel">Returns:</span></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>
</li>
</ul>
<a id="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;clear()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DeliveryQueue.html#clear()">clear</a></code>&nbsp;in interface&nbsp;<code><a href="DeliveryQueue.html" title="interface in org.apache.qpid.protonj2.client.util">DeliveryQueue</a></code></dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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/FifoDeliveryQueue.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="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>