| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 --> |
| <title>ClientStreamReceiver (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="ClientStreamReceiver (Qpid ProtonJ2 Parent 1.0.0-M1 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,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":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"; |
| 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/ClientStreamReceiver.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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </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> <a href="package-summary.html">org.apache.qpid.protonj2.client.impl</a></div> |
| <h2 title="Class ClientStreamReceiver" class="title">Class ClientStreamReceiver</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.client.impl.ClientStreamReceiver</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.lang.AutoCloseable</code>, <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code>, <code><a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">ClientStreamReceiver</span> |
| extends java.lang.Object |
| implements <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></pre> |
| <div class="block">Client implementation of a <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a>.</div> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addCredit(int)">addCredit</a></span>​(int 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>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkClosedOrFailed()">checkClosedOrFailed</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientInstance.html" title="class in org.apache.qpid.protonj2.client.impl">ClientInstance</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#client()">client</a></span>()</code></th> |
| <td class="colLast"> </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()">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="i5" class="rowColor"> |
| <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>​(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> 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="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../futures/ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><<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="#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="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../futures/ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><<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="#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">closeAsync</a></span>​(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> 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="i8" class="altColor"> |
| <td class="colFirst"><code><a href="ClientConnection.html" title="class in org.apache.qpid.protonj2.client.impl">ClientConnection</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connection()">connection</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <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="i10" class="altColor"> |
| <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="i11" class="rowColor"> |
| <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>​(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> 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="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../futures/ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><<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="#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="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../futures/ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><<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="#detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)">detachAsync</a></span>​(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> 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="i14" class="altColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<<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="#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="i15" class="rowColor"> |
| <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="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../futures/ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><<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="#openFuture()">openFuture</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.lang.Object></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="i18" class="altColor"> |
| <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="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</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="../StreamReceiverMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiverMessage</code></a> for consumption.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receive(long,java.util.concurrent.TimeUnit)">receive</a></span>​(long timeout, |
| java.util.concurrent.TimeUnit 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="../StreamReceiverMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiverMessage</code></a> for consumption.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="ClientSession.html" title="class in org.apache.qpid.protonj2.client.impl">ClientSession</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#session()">session</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <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="i23" class="rowColor"> |
| <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="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </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="client()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>client</h4> |
| <pre class="methodSignature">public <a href="ClientInstance.html" title="class in org.apache.qpid.protonj2.client.impl">ClientInstance</a> client()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#client()">client</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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">public <a href="ClientConnection.html" title="class in org.apache.qpid.protonj2.client.impl">ClientConnection</a> connection()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#connection()">connection</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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">public <a href="ClientSession.html" title="class in org.apache.qpid.protonj2.client.impl">ClientSession</a> session()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#session()">session</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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="openFuture()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openFuture</h4> |
| <pre class="methodSignature">public <a href="../futures/ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><<a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>> openFuture()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#openFuture()">openFuture</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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">public void close()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#close()">Receiver</a></code></span></div> |
| <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> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#close()">close</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></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">public void close​(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#close(org.apache.qpid.protonj2.client.ErrorCondition)">Receiver</a></code></span></div> |
| <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><a href="../Receiver.html#close(org.apache.qpid.protonj2.client.ErrorCondition)">close</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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">public void detach()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#detach()">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#detach()">detach</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="detach(org.apache.qpid.protonj2.client.ErrorCondition)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>detach</h4> |
| <pre class="methodSignature">public void detach​(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#detach(org.apache.qpid.protonj2.client.ErrorCondition)">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#detach(org.apache.qpid.protonj2.client.ErrorCondition)">detach</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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">public <a href="../futures/ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><<a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>> closeAsync()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#closeAsync()">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#closeAsync()">closeAsync</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></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="closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeAsync</h4> |
| <pre class="methodSignature">public <a href="../futures/ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><<a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>> closeAsync​(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">closeAsync</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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">public <a href="../futures/ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><<a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>> detachAsync()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#detachAsync()">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#detachAsync()">detachAsync</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></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="detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>detachAsync</h4> |
| <pre class="methodSignature">public <a href="../futures/ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><<a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>> detachAsync​(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)">detachAsync</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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="receive()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>receive</h4> |
| <pre class="methodSignature">public <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a> receive() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../StreamReceiver.html#receive()">StreamReceiver</a></code></span></div> |
| <div class="block">Blocking receive method that waits forever for the remote to provide a <a href="../StreamReceiverMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiverMessage</code></a> for consumption. |
| <p> |
| Receive calls will only grant credit on their own if a credit window is configured in the |
| <a href="../StreamReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>StreamReceiverOptions</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#receive()">receive</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../StreamReceiver.html#receive()">receive</a></code> in interface <code><a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></code></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="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</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">public <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a> receive​(long timeout, |
| java.util.concurrent.TimeUnit unit) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../StreamReceiver.html#receive(long,java.util.concurrent.TimeUnit)">StreamReceiver</a></code></span></div> |
| <div class="block">Blocking receive method that waits the given time interval for the remote to provide a |
| <a href="../StreamReceiverMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiverMessage</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="../StreamReceiverMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiverMessage</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="../StreamReceiverOptions.html" title="class in org.apache.qpid.protonj2.client"><code>StreamReceiverOptions</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="../StreamReceiverMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiverMessage</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#receive(long,java.util.concurrent.TimeUnit)">receive</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../StreamReceiver.html#receive(long,java.util.concurrent.TimeUnit)">receive</a></code> in interface <code><a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></code></dd> |
| <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="../StreamReceiverMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiverMessage</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="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</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">public <a href="../StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a> tryReceive() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../StreamReceiver.html#tryReceive()">StreamReceiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#tryReceive()">tryReceive</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../StreamReceiver.html#tryReceive()">tryReceive</a></code> in interface <code><a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <a href="../StreamReceiverMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiverMessage</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="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> or its parent is closed when the call to try to receive is made.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addCredit(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addCredit</h4> |
| <pre class="methodSignature">public <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a> addCredit​(int credits) |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../StreamReceiver.html#addCredit(int)">StreamReceiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#addCredit(int)">addCredit</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../StreamReceiver.html#addCredit(int)">addCredit</a></code> in interface <code><a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>credits</code> - credit The number of credits to add to the <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> link.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</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="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> link credit.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="drain()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>drain</h4> |
| <pre class="methodSignature">public java.util.concurrent.Future<<a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a>> drain() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#drain()">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#drain()">drain</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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="properties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>properties</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​java.lang.Object> properties() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#properties()">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#properties()">properties</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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">public java.lang.String[] offeredCapabilities() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#offeredCapabilities()">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#offeredCapabilities()">offeredCapabilities</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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">public java.lang.String[] desiredCapabilities() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#desiredCapabilities()">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#desiredCapabilities()">desiredCapabilities</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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="address()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>address</h4> |
| <pre class="methodSignature">public java.lang.String address() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#address()">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#address()">address</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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">public <a href="../Source.html" title="interface in org.apache.qpid.protonj2.client">Source</a> source() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#source()">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#source()">source</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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">public <a href="../Target.html" title="interface in org.apache.qpid.protonj2.client">Target</a> target() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#target()">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#target()">target</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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="queuedDeliveries()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queuedDeliveries</h4> |
| <pre class="methodSignature">public long queuedDeliveries() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Receiver.html#queuedDeliveries()">Receiver</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Receiver.html#queuedDeliveries()">queuedDeliveries</a></code> in interface <code><a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></dd> |
| <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> |
| <a id="checkClosedOrFailed()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>checkClosedOrFailed</h4> |
| <pre class="methodSignature">protected void checkClosedOrFailed() |
| throws <a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <dl> |
| <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></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/ClientStreamReceiver.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 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
