| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ClientStreamReceiver (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ClientStreamReceiver (Qpid ProtonJ2 Parent 1.0.0-M9 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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="../../../../../../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> |
| <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><a href="#field.summary">Field</a> | </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><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="ClientLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">org.apache.qpid.protonj2.client.impl.ClientLinkType</a><ReceiverType,​<a href="../../engine/Receiver.html" title="interface in org.apache.qpid.protonj2.engine">Receiver</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="ClientReceiverLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">org.apache.qpid.protonj2.client.impl.ClientReceiverLinkType</a><<a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.client.impl.ClientStreamReceiver</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code>, <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.client">Link</a><<a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</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 <a href="ClientReceiverLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientReceiverLinkType</a><<a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a>> |
| 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"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.qpid.protonj2.client.impl.ClientReceiverLinkType"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.qpid.protonj2.client.impl.<a href="ClientReceiverLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientReceiverLinkType</a></h3> |
| <code><a href="ClientReceiverLinkType.html#protonReceiver">protonReceiver</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.qpid.protonj2.client.impl.ClientLinkType"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.qpid.protonj2.client.impl.<a href="ClientLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientLinkType</a></h3> |
| <code><a href="ClientLinkType.html#closed">closed</a>, <a href="ClientLinkType.html#CLOSED_UPDATER">CLOSED_UPDATER</a>, <a href="ClientLinkType.html#closeFuture">closeFuture</a>, <a href="ClientLinkType.html#executor">executor</a>, <a href="ClientLinkType.html#failureCause">failureCause</a>, <a href="ClientLinkType.html#linkId">linkId</a>, <a href="ClientLinkType.html#linkRemotelyClosedHandler">linkRemotelyClosedHandler</a>, <a href="ClientLinkType.html#openFuture">openFuture</a>, <a href="ClientLinkType.html#remoteSource">remoteSource</a>, <a href="ClientLinkType.html#remoteTarget">remoteTarget</a>, <a href="ClientLinkType.html#session">session</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> link for use when the receiver has not been configured |
| with a credit window.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a><<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="#drain()">drain</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Requests the remote to drain previously granted credit for this <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> link.</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="#handleDeliveryRead(org.apache.qpid.protonj2.engine.IncomingDelivery)">handleDeliveryRead</a></span>​(<a href="../../engine/IncomingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">IncomingDelivery</a> delivery)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#linkSpecificCleanupHandler(org.apache.qpid.protonj2.client.exceptions.ClientException)">linkSpecificCleanupHandler</a></span>​(<a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a> failureCause)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" 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="i5" 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="i6" 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, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a> 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="i7" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#recreateLinkForReconnect()">recreateLinkForReconnect</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replenishCreditIfNeeded()">replenishCreditIfNeeded</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected <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="#self()">self</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" 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.org.apache.qpid.protonj2.client.impl.ClientReceiverLinkType"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.qpid.protonj2.client.impl.<a href="ClientReceiverLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientReceiverLinkType</a></h3> |
| <code><a href="ClientReceiverLinkType.html#handleDeliveryAborted(org.apache.qpid.protonj2.engine.IncomingDelivery)">handleDeliveryAborted</a>, <a href="ClientReceiverLinkType.html#handleDeliveryStateRemotelyUpdated(org.apache.qpid.protonj2.engine.IncomingDelivery)">handleDeliveryStateRemotelyUpdated</a>, <a href="ClientReceiverLinkType.html#handleReceiverCreditUpdated(org.apache.qpid.protonj2.engine.Receiver)">handleReceiverCreditUpdated</a>, <a href="ClientReceiverLinkType.html#linkSpecificLocalCloseHandler()">linkSpecificLocalCloseHandler</a>, <a href="ClientReceiverLinkType.html#linkSpecificLocalOpenHandler()">linkSpecificLocalOpenHandler</a>, <a href="ClientReceiverLinkType.html#linkSpecificRemoteCloseHandler()">linkSpecificRemoteCloseHandler</a>, <a href="ClientReceiverLinkType.html#linkSpecificRemoteOpenHandler()">linkSpecificRemoteOpenHandler</a>, <a href="ClientReceiverLinkType.html#protonLink()">protonLink</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.client.impl.ClientLinkType"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.qpid.protonj2.client.impl.<a href="ClientLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientLinkType</a></h3> |
| <code><a href="ClientLinkType.html#address()">address</a>, <a href="ClientLinkType.html#checkClosedOrFailed()">checkClosedOrFailed</a>, <a href="ClientLinkType.html#client()">client</a>, <a href="ClientLinkType.html#close()">close</a>, <a href="ClientLinkType.html#close(org.apache.qpid.protonj2.client.ErrorCondition)">close</a>, <a href="ClientLinkType.html#closeAsync()">closeAsync</a>, <a href="ClientLinkType.html#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">closeAsync</a>, <a href="ClientLinkType.html#connection()">connection</a>, <a href="ClientLinkType.html#desiredCapabilities()">desiredCapabilities</a>, <a href="ClientLinkType.html#detach()">detach</a>, <a href="ClientLinkType.html#detach(org.apache.qpid.protonj2.client.ErrorCondition)">detach</a>, <a href="ClientLinkType.html#detachAsync()">detachAsync</a>, <a href="ClientLinkType.html#detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)">detachAsync</a>, <a href="ClientLinkType.html#handleEngineShutdown(org.apache.qpid.protonj2.engine.Engine)">handleEngineShutdown</a>, <a href="ClientLinkType.html#handleLocalCloseOrDetach(ProtonType)">handleLocalCloseOrDetach</a>, <a href="ClientLinkType.html#handleLocalOpen(ProtonType)">handleLocalOpen</a>, <a href="ClientLinkType.html#handleParentEndpointClosed(ProtonType)">handleParentEndpointClosed</a>, <a href="ClientLinkType.html#handleRemoteCloseOrDetach(ProtonType)">handleRemoteCloseOrDetach</a>, <a href="ClientLinkType.html#handleRemoteOpen(ProtonType)">handleRemoteOpen</a>, <a href="ClientLinkType.html#immediateLinkShutdown(org.apache.qpid.protonj2.client.exceptions.ClientException)">immediateLinkShutdown</a>, <a href="ClientLinkType.html#notClosedOrFailed(org.apache.qpid.protonj2.client.futures.ClientFuture)">notClosedOrFailed</a>, <a href="ClientLinkType.html#notClosedOrFailed(org.apache.qpid.protonj2.client.futures.ClientFuture,ProtonType)">notClosedOrFailed</a>, <a href="ClientLinkType.html#offeredCapabilities()">offeredCapabilities</a>, <a href="ClientLinkType.html#openFuture()">openFuture</a>, <a href="ClientLinkType.html#properties()">properties</a>, <a href="ClientLinkType.html#session()">session</a>, <a href="ClientLinkType.html#source()">source</a>, <a href="ClientLinkType.html#target()">target</a>, <a href="ClientLinkType.html#waitForOpenToComplete()">waitForOpenToComplete</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.client.Link"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.qpid.protonj2.client.<a href="../Link.html" title="interface in org.apache.qpid.protonj2.client">Link</a></h3> |
| <code><a href="../Link.html#address()">address</a>, <a href="../Link.html#client()">client</a>, <a href="../Link.html#close()">close</a>, <a href="../Link.html#close(org.apache.qpid.protonj2.client.ErrorCondition)">close</a>, <a href="../Link.html#closeAsync()">closeAsync</a>, <a href="../Link.html#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">closeAsync</a>, <a href="../Link.html#connection()">connection</a>, <a href="../Link.html#desiredCapabilities()">desiredCapabilities</a>, <a href="../Link.html#detach()">detach</a>, <a href="../Link.html#detach(org.apache.qpid.protonj2.client.ErrorCondition)">detach</a>, <a href="../Link.html#detachAsync()">detachAsync</a>, <a href="../Link.html#detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)">detachAsync</a>, <a href="../Link.html#offeredCapabilities()">offeredCapabilities</a>, <a href="../Link.html#openFuture()">openFuture</a>, <a href="../Link.html#properties()">properties</a>, <a href="../Link.html#session()">session</a>, <a href="../Link.html#source()">source</a>, <a href="../Link.html#target()">target</a></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="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="../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, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a> 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="../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="../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="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> link for use when the 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="../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> - 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="../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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a><<a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</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="../StreamReceiver.html#drain()">StreamReceiver</a></code></span></div> |
| <div class="block">Requests the remote to drain previously granted credit for this <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> link.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../StreamReceiver.html#drain()">drain</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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be completed when the remote drains this <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</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="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="../StreamReceiver.html#queuedDeliveries()">StreamReceiver</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="../StreamReceiver.html#queuedDeliveries()">queuedDeliveries</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>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="self()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>self</h4> |
| <pre class="methodSignature">protected <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a> self()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ClientLinkType.html#self()">self</a></code> in class <code><a href="ClientLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientLinkType</a><<a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a>,​<a href="../../engine/Receiver.html" title="interface in org.apache.qpid.protonj2.engine">Receiver</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="handleDeliveryRead(org.apache.qpid.protonj2.engine.IncomingDelivery)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleDeliveryRead</h4> |
| <pre class="methodSignature">protected void handleDeliveryRead​(<a href="../../engine/IncomingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">IncomingDelivery</a> delivery)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ClientReceiverLinkType.html#handleDeliveryRead(org.apache.qpid.protonj2.engine.IncomingDelivery)">handleDeliveryRead</a></code> in class <code><a href="ClientReceiverLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientReceiverLinkType</a><<a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="replenishCreditIfNeeded()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>replenishCreditIfNeeded</h4> |
| <pre class="methodSignature">protected void replenishCreditIfNeeded()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ClientReceiverLinkType.html#replenishCreditIfNeeded()">replenishCreditIfNeeded</a></code> in class <code><a href="ClientReceiverLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientReceiverLinkType</a><<a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="linkSpecificCleanupHandler(org.apache.qpid.protonj2.client.exceptions.ClientException)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>linkSpecificCleanupHandler</h4> |
| <pre class="methodSignature">protected void linkSpecificCleanupHandler​(<a href="../exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a> failureCause)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="ClientReceiverLinkType.html#linkSpecificCleanupHandler(org.apache.qpid.protonj2.client.exceptions.ClientException)">linkSpecificCleanupHandler</a></code> in class <code><a href="ClientReceiverLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientReceiverLinkType</a><<a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="recreateLinkForReconnect()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>recreateLinkForReconnect</h4> |
| <pre class="methodSignature">protected void recreateLinkForReconnect()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="ClientLinkType.html#recreateLinkForReconnect()">recreateLinkForReconnect</a></code> in class <code><a href="ClientLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientLinkType</a><<a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a>,​<a href="../../engine/Receiver.html" title="interface in org.apache.qpid.protonj2.engine">Receiver</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="../../../../../../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><a href="#field.summary">Field</a> | </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 © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |