blob: a078dc4a092fe2615d3a068afd6757ad89ddaee0 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Class org.apache.qpid.protonj2.client.futures.ClientFuture (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="Uses of Class org.apache.qpid.protonj2.client.futures.ClientFuture (Qpid ProtonJ2 Parent 1.0.0-M9 API)";
}
}
catch(err) {
}
//-->
</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><a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h2 title="Uses of Class org.apache.qpid.protonj2.client.futures.ClientFuture" class="title">Uses of Class<br>org.apache.qpid.protonj2.client.futures.ClientFuture</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.qpid.protonj2.client.futures">org.apache.qpid.protonj2.client.futures</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.qpid.protonj2.client.impl">org.apache.qpid.protonj2.client.impl</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section role="region"><a id="org.apache.qpid.protonj2.client.futures">
<!-- -->
</a>
<h3>Uses of <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.client.futures</a></h3>
<table class="useSummary">
<caption><span>Subclasses of <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.client.futures</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../BalancedClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">BalancedClientFuture</a>&lt;V&gt;</span></code></th>
<td class="colLast">
<div class="block">A more balanced implementation of a ClientFuture that works better on some
platforms such as windows where the thread park and atomic operations used by
a more aggressive implementation could result in poor performance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../ConservativeClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ConservativeClientFuture</a>&lt;V&gt;</span></code></th>
<td class="colLast">
<div class="block">A more conservative implementation of a ClientFuture that is better on some
platforms or resource constrained hardware where high CPU usage can be more
counter productive than other variants that might spin or otherwise avoid
entry into states requiring thread signaling.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../ProgressiveClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ProgressiveClientFuture</a>&lt;V&gt;</span></code></th>
<td class="colLast">
<div class="block">An optimized version of a ClientFuture that makes use of spin waits and other
methods of reacting to asynchronous completion in a more timely manner.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Fields in <a href="../package-summary.html">org.apache.qpid.protonj2.client.futures</a> with type parameters of type <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/atomic/AtomicIntegerFieldUpdater.html?is-external=true" title="class or interface in java.util.concurrent.atomic" class="externalLink">AtomicIntegerFieldUpdater</a>&lt;<a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientFuture.</span><code><span class="memberNameLink"><a href="../ClientFuture.html#STATE_FIELD_UPDATER">STATE_FIELD_UPDATER</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.client.futures</a> that return <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a></span><span class="tabEnd">&nbsp;</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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>abstract &lt;V&gt;&nbsp;<a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;V&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientFutureFactory.</span><code><span class="memberNameLink"><a href="../ClientFutureFactory.html#createFuture()">createFuture</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract &lt;V&gt;&nbsp;<a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;V&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientFutureFactory.</span><code><span class="memberNameLink"><a href="../ClientFutureFactory.html#createFuture(org.apache.qpid.protonj2.client.futures.ClientSynchronization)">createFuture</a></span>&#8203;(<a href="../ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures">ClientSynchronization</a>&lt;V&gt;&nbsp;synchronization)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract &lt;V&gt;&nbsp;<a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;V&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientFutureFactory.</span><code><span class="memberNameLink"><a href="../ClientFutureFactory.html#createUnfailableFuture()">createUnfailableFuture</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract &lt;V&gt;&nbsp;<a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;V&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientFutureFactory.</span><code><span class="memberNameLink"><a href="../ClientFutureFactory.html#createUnfailableFuture(org.apache.qpid.protonj2.client.futures.ClientSynchronization)">createUnfailableFuture</a></span>&#8203;(<a href="../ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures">ClientSynchronization</a>&lt;V&gt;&nbsp;synchronization)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section role="region"><a id="org.apache.qpid.protonj2.client.impl">
<!-- -->
</a>
<h3>Uses of <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a> in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a></h3>
<table class="useSummary">
<caption><span>Fields in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a> declared as <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;<a href="../../impl/ClientLinkType.html" title="type parameter in ClientLinkType">LinkType</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientLinkType.</span><code><span class="memberNameLink"><a href="../../impl/ClientLinkType.html#closeFuture">closeFuture</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;<a href="../../impl/ClientReceiverLinkType.html" title="type parameter in ClientReceiverLinkType">ReceiverType</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientReceiverLinkType.</span><code><span class="memberNameLink"><a href="../../impl/ClientReceiverLinkType.html#drainingFuture">drainingFuture</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;<a href="../../impl/ClientLinkType.html" title="type parameter in ClientLinkType">LinkType</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientLinkType.</span><code><span class="memberNameLink"><a href="../../impl/ClientLinkType.html#openFuture">openFuture</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a> that return <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a></span><span class="tabEnd">&nbsp;</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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;<a href="../../impl/ClientLinkType.html" title="type parameter in ClientLinkType">LinkType</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientLinkType.</span><code><span class="memberNameLink"><a href="../../impl/ClientLinkType.html#closeAsync()">closeAsync</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;<a href="../../impl/ClientLinkType.html" title="type parameter in ClientLinkType">LinkType</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientLinkType.</span><code><span class="memberNameLink"><a href="../../impl/ClientLinkType.html#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">closeAsync</a></span>&#8203;(<a href="../../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;<a href="../../impl/ClientLinkType.html" title="type parameter in ClientLinkType">LinkType</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientLinkType.</span><code><span class="memberNameLink"><a href="../../impl/ClientLinkType.html#detachAsync()">detachAsync</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;<a href="../../impl/ClientLinkType.html" title="type parameter in ClientLinkType">LinkType</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientLinkType.</span><code><span class="memberNameLink"><a href="../../impl/ClientLinkType.html#detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)">detachAsync</a></span>&#8203;(<a href="../../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;<a href="../../impl/ClientLinkType.html" title="type parameter in ClientLinkType">LinkType</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientLinkType.</span><code><span class="memberNameLink"><a href="../../impl/ClientLinkType.html#openFuture()">openFuture</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;<a href="../../impl/ClientTrackable.html" title="type parameter in ClientTrackable">TrackerType</a>&gt;</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientTrackable.</span><code><span class="memberNameLink"><a href="../../impl/ClientTrackable.html#settlementFuture()">settlementFuture</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a> with parameters of type <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a></span><span class="tabEnd">&nbsp;</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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientLinkType.</span><code><span class="memberNameLink"><a href="../../impl/ClientLinkType.html#notClosedOrFailed(org.apache.qpid.protonj2.client.futures.ClientFuture)">notClosedOrFailed</a></span>&#8203;(<a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;?&gt;&nbsp;request)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientLinkType.</span><code><span class="memberNameLink"><a href="../../impl/ClientLinkType.html#notClosedOrFailed(org.apache.qpid.protonj2.client.futures.ClientFuture,ProtonType)">notClosedOrFailed</a></span>&#8203;(<a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;?&gt;&nbsp;request,
<a href="../../impl/ClientLinkType.html" title="type parameter in ClientLinkType">ProtonType</a>&nbsp;protonLink)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Constructors in <a href="../../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a> with parameters of type <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../impl/ClientStreamSender.ClientOutgoingEnvelope.html#%3Cinit%3E(org.apache.qpid.protonj2.client.impl.ClientStreamSender,org.apache.qpid.protonj2.engine.OutgoingDelivery,int,org.apache.qpid.protonj2.buffer.ProtonBuffer,boolean,org.apache.qpid.protonj2.client.futures.ClientFuture)">ClientOutgoingEnvelope</a></span>&#8203;(<a href="../../impl/ClientStreamSender.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamSender</a>&nbsp;sender,
<a href="../../../engine/OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a>&nbsp;delivery,
int&nbsp;messageFormat,
<a href="../../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a>&nbsp;payload,
boolean&nbsp;complete,
<a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;<a href="../../StreamTracker.html" title="interface in org.apache.qpid.protonj2.client">StreamTracker</a>&gt;&nbsp;request)</code></th>
<td class="colLast">
<div class="block">Create a new In-flight Send instance that is a continuation on an existing delivery.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</li>
</ul>
</div>
</main>
<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><a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>