| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 --> |
| <title>StreamTracker (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="StreamTracker (Qpid ProtonJ2 Parent 1.0.0-M1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/StreamTracker.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</a></div> |
| <h2 title="Interface StreamTracker" class="title">Interface StreamTracker</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/ClientNoOpStreamTracker.html" title="class in org.apache.qpid.protonj2.client.impl">ClientNoOpStreamTracker</a></code>, <code><a href="impl/ClientStreamTracker.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamTracker</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">StreamTracker</span> |
| extends <a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></pre> |
| <div class="block">Special StreamSender related <a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client"><code>Tracker</code></a> that is linked to any <a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSenderMessage</code></a> |
| instance and provides the <a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client"><code>Tracker</code></a> functions for those types of messages.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client">StreamTracker</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#awaitSettlement()">awaitSettlement</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Waits if necessary for the remote to settle the sent delivery unless it has |
| either already been settled or the original delivery was sent settled in which |
| case the remote will not send a <a href="../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Disposition</code></a> back.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client">StreamTracker</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#awaitSettlement(long,java.util.concurrent.TimeUnit)">awaitSettlement</a></span>​(long timeout, |
| java.util.concurrent.TimeUnit unit)</code></th> |
| <td class="colLast"> |
| <div class="block">Waits if necessary for the remote to settle the sent delivery unless it has |
| either already been settled or the original delivery was sent settled in which |
| case the remote will not send a <a href="../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Disposition</code></a> back.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client">StreamTracker</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)">disposition</a></span>​(<a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a> state, |
| boolean settle)</code></th> |
| <td class="colLast"> |
| <div class="block">Updates the DeliveryState, and optionally settle the delivery as well.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sender()">sender</a></span>()</code></th> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client">StreamTracker</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#settle()">settle</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Settles the delivery locally, if not <a href="SenderOptions.html#autoSettle()"><code>auto-settling</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<<a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#settlementFuture()">settlementFuture</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a future that can be used to wait for the remote to acknowledge receipt of |
| a sent message by settling it.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.client.Tracker"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.qpid.protonj2.client.<a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></h3> |
| <code><a href="Tracker.html#awaitAccepted()">awaitAccepted</a>, <a href="Tracker.html#awaitAccepted(long,java.util.concurrent.TimeUnit)">awaitAccepted</a>, <a href="Tracker.html#remoteSettled()">remoteSettled</a>, <a href="Tracker.html#remoteState()">remoteState</a>, <a href="Tracker.html#settled()">settled</a>, <a href="Tracker.html#state()">state</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="sender()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sender</h4> |
| <pre class="methodSignature"><a href="StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a> sender()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Tracker.html#sender()">sender</a></code> in interface <code><a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="StreamSender.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSender</code></a> that is associated with this <a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamTracker</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="settle()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>settle</h4> |
| <pre class="methodSignature"><a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client">StreamTracker</a> settle() |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Settles the delivery locally, if not <a href="SenderOptions.html#autoSettle()"><code>auto-settling</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Tracker.html#settle()">settle</a></code> in interface <code><a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamTracker</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 performing the settlement.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="settlementFuture()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>settlementFuture</h4> |
| <pre class="methodSignature">java.util.concurrent.Future<<a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a>> settlementFuture()</pre> |
| <div class="block">Returns a future that can be used to wait for the remote to acknowledge receipt of |
| a sent message by settling it.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Tracker.html#settlementFuture()">settlementFuture</a></code> in interface <code><a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>Future</code> that can be used to wait on remote settlement.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>disposition</h4> |
| <pre class="methodSignature"><a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client">StreamTracker</a> disposition​(<a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a> state, |
| boolean settle) |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Updates the DeliveryState, and optionally settle the delivery as well.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Tracker.html#disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)">disposition</a></code> in interface <code><a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>state</code> - the delivery state to apply</dd> |
| <dd><code>settle</code> - whether to <a href="Tracker.html#settle()"><code>Tracker.settle()</code></a> the delivery at the same time</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamTracker</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 applying the given disposition</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="awaitSettlement()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>awaitSettlement</h4> |
| <pre class="methodSignature"><a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client">StreamTracker</a> awaitSettlement() |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Waits if necessary for the remote to settle the sent delivery unless it has |
| either already been settled or the original delivery was sent settled in which |
| case the remote will not send a <a href="../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Disposition</code></a> back.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Tracker.html#awaitSettlement()">awaitSettlement</a></code> in interface <code><a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamTracker</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 awaiting the remote settlement.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="awaitSettlement(long,java.util.concurrent.TimeUnit)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>awaitSettlement</h4> |
| <pre class="methodSignature"><a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client">StreamTracker</a> awaitSettlement​(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">Waits if necessary for the remote to settle the sent delivery unless it has |
| either already been settled or the original delivery was sent settled in which |
| case the remote will not send a <a href="../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Disposition</code></a> back.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Tracker.html#awaitSettlement(long,java.util.concurrent.TimeUnit)">awaitSettlement</a></code> in interface <code><a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - the maximum time to wait for the remote to settle.</dd> |
| <dd><code>unit</code> - the time unit of the timeout argument.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamTracker</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 awaiting the remote settlement.</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/StreamTracker.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> |
