Google Git
Sign in
apache / qpid-site / 38b7a5c180954434c6ffaa49d533f6dd550a57b0 / . / input / releases / qpid-protonj2-1.0.0-M1 / api / org / apache / qpid / protonj2 / client / Receiver.html
blob: 5b969be8fe81f533f9dd1635ac53d3aaec5f210b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 -->
<title>Receiver (Qpid ProtonJ2 Parent 1.0.0-M1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-05-12">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Receiver (Qpid ProtonJ2 Parent 1.0.0-M1 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6};
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 = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</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/Receiver.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-all.html">Index</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>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a 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</a></div>
<h2 title="Interface Receiver" class="title">Interface Receiver</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code>java.lang.AutoCloseable</code></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="impl/ClientReceiver.html" title="class in org.apache.qpid.protonj2.client.impl">ClientReceiver</a></code>, <code><a href="impl/ClientStreamReceiver.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamReceiver</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Receiver</span>
extends java.lang.AutoCloseable</pre>
<div class="block">AMQP Receiver that provides an interface to receive complete Deliveries from a remote
peer. Deliveries that are returned from the <a href="#receive()"><code>receive()</code></a> methods will be complete
and can be read immediately without blocking waiting for additional delivery data to arrive.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addCredit(int)">addCredit</a></span>&#8203;(int&nbsp;credits)</code></th>
<td class="colLast">
<div class="block">Adds credit to the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link for use when there receiver has not been configured
with a credit window.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#address()">address</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the address that the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance will be subscribed to.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#client()">client</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" 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">Requests a close of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> at the remote and waits until the Receiver has been
fully closed or until the configured <a href="ReceiverOptions.html#closeTimeout()"><code>ReceiverOptions.closeTimeout()</code></a> is exceeded.</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="#close(org.apache.qpid.protonj2.client.ErrorCondition)">close</a></span>&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</code></th>
<td class="colLast">
<div class="block">Requests a close of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> at the remote and waits until the Receiver has been
fully closed or until the configured <a href="ReceiverOptions.html#closeTimeout()"><code>ReceiverOptions.closeTimeout()</code></a> is exceeded.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.concurrent.Future&lt;<a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeAsync()">closeAsync</a></span>()</code></th>
<td class="colLast">
<div class="block">Requests a close of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link at the remote and returns a <code>Future</code> that will be
completed once the link has been closed.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.concurrent.Future&lt;<a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">closeAsync</a></span>&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</code></th>
<td class="colLast">
<div class="block">Requests a close of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link at the remote and returns a <code>Future</code> that will be
completed once the link has been closed.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connection()">connection</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#desiredCapabilities()">desiredCapabilities</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the desired capabilities that the remote provided upon successfully opening the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detach()">detach</a></span>()</code></th>
<td class="colLast">
<div class="block">Requests a detach of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> at the remote and waits until the Receiver has been
fully detached or until the configured <a href="SenderOptions.html#closeTimeout()"><code>SenderOptions.closeTimeout()</code></a> is exceeded.</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="#detach(org.apache.qpid.protonj2.client.ErrorCondition)">detach</a></span>&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</code></th>
<td class="colLast">
<div class="block">Requests a detach of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> at the remote and waits until the Receiver has been
fully detached or until the configured <a href="SenderOptions.html#closeTimeout()"><code>SenderOptions.closeTimeout()</code></a> is exceeded.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.util.concurrent.Future&lt;<a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detachAsync()">detachAsync</a></span>()</code></th>
<td class="colLast">
<div class="block">Requests a detach of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link at the remote and returns a <code>Future</code> that will be
completed once the link has been detached.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.util.concurrent.Future&lt;<a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)">detachAsync</a></span>&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</code></th>
<td class="colLast">
<div class="block">Requests a detach of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link at the remote and returns a <code>Future</code> that will be
completed once the link has been detached.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.util.concurrent.Future&lt;<a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#drain()">drain</a></span>()</code></th>
<td class="colLast">
<div class="block">Requests the remote to drain previously granted credit for this <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#offeredCapabilities()">offeredCapabilities</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the offered capabilities that the remote provided upon successfully opening the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.util.concurrent.Future&lt;<a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openFuture()">openFuture</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties()">properties</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the properties that the remote provided upon successfully opening the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queuedDeliveries()">queuedDeliveries</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the number of Deliveries that are currently held in the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> delivery
queue.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receive()">receive</a></span>()</code></th>
<td class="colLast">
<div class="block">Blocking receive method that waits forever for the remote to provide a <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> for consumption.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receive(long,java.util.concurrent.TimeUnit)">receive</a></span>&#8203;(long&nbsp;timeout,
java.util.concurrent.TimeUnit&nbsp;unit)</code></th>
<td class="colLast">
<div class="block">Blocking receive method that waits the given time interval for the remote to provide a
<a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> for consumption.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#session()">session</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="Source.html" title="interface in org.apache.qpid.protonj2.client">Source</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#source()">source</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an immutable view of the remote <a href="Source.html" title="interface in org.apache.qpid.protonj2.client"><code>Source</code></a> object assigned to this receiver link.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="Target.html" title="interface in org.apache.qpid.protonj2.client">Target</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#target()">target</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an immutable view of the remote <a href="Target.html" title="interface in org.apache.qpid.protonj2.client"><code>Target</code></a> object assigned to this receiver link.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tryReceive()">tryReceive</a></span>()</code></th>
<td class="colLast">
<div class="block">Non-blocking receive method that either returns a message is one is immediately available or
returns null if none is currently at hand.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="openFuture()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>openFuture</h4>
<pre class="methodSignature">java.util.concurrent.Future&lt;<a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&gt;&nbsp;openFuture()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>Future</code> that will be completed when the remote opens this <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>.</dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">void&nbsp;close()</pre>
<div class="block">Requests a close of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> at the remote and waits until the Receiver has been
fully closed or until the configured <a href="ReceiverOptions.html#closeTimeout()"><code>ReceiverOptions.closeTimeout()</code></a> is exceeded.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
</dl>
</li>
</ul>
<a id="close(org.apache.qpid.protonj2.client.ErrorCondition)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">void&nbsp;close&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</pre>
<div class="block">Requests a close of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> at the remote and waits until the Receiver has been
fully closed or until the configured <a href="ReceiverOptions.html#closeTimeout()"><code>ReceiverOptions.closeTimeout()</code></a> is exceeded.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>error</code> - The <a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client"><code>ErrorCondition</code></a> to transmit to the remote along with the close operation.</dd>
</dl>
</li>
</ul>
<a id="detach()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detach</h4>
<pre class="methodSignature">void&nbsp;detach()</pre>
<div class="block">Requests a detach of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> at the remote and waits until the Receiver has been
fully detached or until the configured <a href="SenderOptions.html#closeTimeout()"><code>SenderOptions.closeTimeout()</code></a> is exceeded.</div>
</li>
</ul>
<a id="detach(org.apache.qpid.protonj2.client.ErrorCondition)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detach</h4>
<pre class="methodSignature">void&nbsp;detach&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</pre>
<div class="block">Requests a detach of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> at the remote and waits until the Receiver has been
fully detached or until the configured <a href="SenderOptions.html#closeTimeout()"><code>SenderOptions.closeTimeout()</code></a> is exceeded.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>error</code> - The <a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client"><code>ErrorCondition</code></a> to transmit to the remote along with the detach operation.</dd>
</dl>
</li>
</ul>
<a id="closeAsync()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeAsync</h4>
<pre class="methodSignature">java.util.concurrent.Future&lt;<a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&gt;&nbsp;closeAsync()</pre>
<div class="block">Requests a close of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link at the remote and returns a <code>Future</code> that will be
completed once the link has been closed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>Future</code> that will be completed when the remote closes this <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link.</dd>
</dl>
</li>
</ul>
<a id="closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>closeAsync</h4>
<pre class="methodSignature">java.util.concurrent.Future&lt;<a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&gt;&nbsp;closeAsync&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</pre>
<div class="block">Requests a close of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link at the remote and returns a <code>Future</code> that will be
completed once the link has been closed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>error</code> - The <a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client"><code>ErrorCondition</code></a> to transmit to the remote along with the close operation.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>Future</code> that will be completed when the remote closes this <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link.</dd>
</dl>
</li>
</ul>
<a id="detachAsync()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detachAsync</h4>
<pre class="methodSignature">java.util.concurrent.Future&lt;<a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&gt;&nbsp;detachAsync()</pre>
<div class="block">Requests a detach of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link at the remote and returns a <code>Future</code> that will be
completed once the link has been detached.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>Future</code> that will be completed when the remote detaches this <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link.</dd>
</dl>
</li>
</ul>
<a id="detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detachAsync</h4>
<pre class="methodSignature">java.util.concurrent.Future&lt;<a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&gt;&nbsp;detachAsync&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</pre>
<div class="block">Requests a detach of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link at the remote and returns a <code>Future</code> that will be
completed once the link has been detached.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>error</code> - The <a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client"><code>ErrorCondition</code></a> to transmit to the remote along with the detach operation.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>Future</code> that will be completed when the remote detaches this <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link.</dd>
</dl>
</li>
</ul>
<a id="address()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>address</h4>
<pre class="methodSignature">java.lang.String&nbsp;address()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Returns the address that the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance will be subscribed to.
<ul>
<li>
If the Receiver was created with the dynamic receiver methods then the method will return
the dynamically created address once the remote has attached its end of the receiver link.
Due to the need to await the remote peer to populate the dynamic address this method will
block until the open of the receiver link has completed.
</li>
<li>
If not a dynamic receiver then the address returned is the address passed to the original
<a href="Session.html#openReceiver(java.lang.String)"><code>Session.openReceiver(String)</code></a> or <a href="Session.html#openReceiver(java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)"><code>Session.openReceiver(String, ReceiverOptions)</code></a> methods.
</li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the address that this <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> is sending to.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> address.</dd>
</dl>
</li>
</ul>
<a id="source()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>source</h4>
<pre class="methodSignature"><a href="Source.html" title="interface in org.apache.qpid.protonj2.client">Source</a>&nbsp;source()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Returns an immutable view of the remote <a href="Source.html" title="interface in org.apache.qpid.protonj2.client"><code>Source</code></a> object assigned to this receiver link. If the
attach has not completed yet this method will block to await the attach response which carries the remote
<a href="Source.html" title="interface in org.apache.qpid.protonj2.client"><code>Source</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the remote <a href="Source.html" title="interface in org.apache.qpid.protonj2.client"><code>Source</code></a> node configuration.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> remote <a href="Source.html" title="interface in org.apache.qpid.protonj2.client"><code>Source</code></a>.</dd>
</dl>
</li>
</ul>
<a id="target()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>target</h4>
<pre class="methodSignature"><a href="Target.html" title="interface in org.apache.qpid.protonj2.client">Target</a>&nbsp;target()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Returns an immutable view of the remote <a href="Target.html" title="interface in org.apache.qpid.protonj2.client"><code>Target</code></a> object assigned to this receiver link. If the
attach has not completed yet this method will block to await the attach response which carries the remote
<a href="Source.html" title="interface in org.apache.qpid.protonj2.client"><code>Source</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the remote <a href="Target.html" title="interface in org.apache.qpid.protonj2.client"><code>Target</code></a> node configuration.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> remote <a href="Target.html" title="interface in org.apache.qpid.protonj2.client"><code>Target</code></a>.</dd>
</dl>
</li>
</ul>
<a id="properties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>properties</h4>
<pre class="methodSignature">java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;properties()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Returns the properties that the remote provided upon successfully opening the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>. If the
attach has not completed yet this method will block to await the attach response which carries the remote
properties. If the remote provides no properties this method will return null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>any properties provided from the remote once the receiver has successfully opened.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> remote properties.</dd>
</dl>
</li>
</ul>
<a id="offeredCapabilities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offeredCapabilities</h4>
<pre class="methodSignature">java.lang.String[]&nbsp;offeredCapabilities()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Returns the offered capabilities that the remote provided upon successfully opening the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>.
If the attach has not completed yet this method will block to await the attach response which carries the
remote offered capabilities. If the remote provides no capabilities this method will return null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>any capabilities provided from the remote once the receiver has successfully opened.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> remote offered capabilities.</dd>
</dl>
</li>
</ul>
<a id="desiredCapabilities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>desiredCapabilities</h4>
<pre class="methodSignature">java.lang.String[]&nbsp;desiredCapabilities()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Returns the desired capabilities that the remote provided upon successfully opening the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>.
If the attach has not completed yet this method will block to await the attach response which carries the
remote desired capabilities. If the remote provides no capabilities this method will return null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>any desired capabilities provided from the remote once the receiver has successfully opened.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> remote desired capabilities.</dd>
</dl>
</li>
</ul>
<a id="client()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>client</h4>
<pre class="methodSignature"><a href="Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a>&nbsp;client()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="Client.html" title="interface in org.apache.qpid.protonj2.client"><code>Client</code></a> instance that holds this session's <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a></dd>
</dl>
</li>
</ul>
<a id="connection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connection</h4>
<pre class="methodSignature"><a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>&nbsp;connection()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> instance that holds this session's <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a></dd>
</dl>
</li>
</ul>
<a id="session()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>session</h4>
<pre class="methodSignature"><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>&nbsp;session()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> that created and holds this <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a>.</dd>
</dl>
</li>
</ul>
<a id="addCredit(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addCredit</h4>
<pre class="methodSignature"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&nbsp;addCredit&#8203;(int&nbsp;credits)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Adds credit to the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link for use when there receiver has not been configured
with a credit window. When credit window is configured credit replenishment is automatic and
calling this method will result in an exception indicating that the operation is invalid.
<p>
If the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> is draining and this method is called an exception will be thrown
to indicate that credit cannot be replenished until the remote has drained the existing link
credit.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>credits</code> - The number of credits to add to the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while attempting to add new <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link credit.</dd>
</dl>
</li>
</ul>
<a id="receive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receive</h4>
<pre class="methodSignature"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a>&nbsp;receive()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Blocking receive method that waits forever for the remote to provide a <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> for consumption.
<p>
Receive calls will only grant credit on their own if a credit window is configured in the
<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> which is done by default. If the client application has configured
no credit window than this method will not grant any credit when it enters the wait for new
incoming messages.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> received from the remote.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> or its parent is closed when the call to receive is made.</dd>
</dl>
</li>
</ul>
<a id="receive(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receive</h4>
<pre class="methodSignature"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a>&nbsp;receive&#8203;(long&nbsp;timeout,
java.util.concurrent.TimeUnit&nbsp;unit)
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Blocking receive method that waits the given time interval for the remote to provide a
<a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> for consumption. The amount of time this method blocks is based on the
timeout value. If timeout is equal to <code>-1</code> then it blocks until a Delivery is
received. If timeout is equal to zero then it will not block and simply return a
<a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> if one is available locally. If timeout value is greater than zero then it
blocks up to timeout amount of time.
<p>
Receive calls will only grant credit on their own if a credit window is configured in the
<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ReceiverOptions</code></a> which is done by default. If the client application has not configured
a credit window or granted credit manually this method will not automatically grant any credit
when it enters the wait for a new incoming <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - The timeout value used to control how long the receive method waits for a new <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a>.</dd>
<dd><code>unit</code> - The unit of time that the given timeout represents.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> received from the remote.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> or its parent is closed when the call to receive is made.</dd>
</dl>
</li>
</ul>
<a id="tryReceive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tryReceive</h4>
<pre class="methodSignature"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a>&nbsp;tryReceive()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Non-blocking receive method that either returns a message is one is immediately available or
returns null if none is currently at hand.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> received from the remote or null if no pending deliveries are available.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> or its parent is closed when the call to try to receive is made.</dd>
</dl>
</li>
</ul>
<a id="drain()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drain</h4>
<pre class="methodSignature">java.util.concurrent.Future&lt;<a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>&gt;&nbsp;drain()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Requests the remote to drain previously granted credit for this <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>Future</code> that will be completed when the remote drains this <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> link.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while attempting to drain the link credit.</dd>
</dl>
</li>
</ul>
<a id="queuedDeliveries()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>queuedDeliveries</h4>
<pre class="methodSignature">long&nbsp;queuedDeliveries()
throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
<div class="block">Returns the number of Deliveries that are currently held in the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> delivery
queue. This number is likely to change immediately following the call as more deliveries
arrive but can be used to determine if any pending <a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client"><code>Delivery</code></a> work is ready.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of deliveries that are currently buffered locally.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while attempting to fetch the queue count.</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/Receiver.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-all.html">Index</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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>