blob: fa1c50880533448cb31a222fe352616cb5273d37 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Class org.apache.qpid.protonj2.client.futures.ClientFuture (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="use: package: org.apache.qpid.protonj2.client.futures, class: ClientFuture">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body class="class-use-page">
<script type="text/javascript"></script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" 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="nav-bar-cell1-rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../../help-doc.html#use">Help</a></li>
</ul>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Uses of Class org.apache.qpid.protonj2.client.futures.ClientFuture" class="title">Uses of Class<br>org.apache.qpid.protonj2.client.futures.ClientFuture</h1>
</div>
<div class="caption"><span>Packages that use <a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.qpid.protonj2.client.futures">org.apache.qpid.protonj2.client.futures</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.qpid.protonj2.client.impl">org.apache.qpid.protonj2.client.impl</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.qpid.protonj2.client.futures">
<h2>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></h2>
<div class="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></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../BalancedClientFuture.html" class="type-name-link" title="class in org.apache.qpid.protonj2.client.futures">BalancedClientFuture</a>&lt;V&gt;</code></div>
<div class="col-last even-row-color">
<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>
</div>
<div class="col-first odd-row-color"><code>class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../ConservativeClientFuture.html" class="type-name-link" title="class in org.apache.qpid.protonj2.client.futures">ConservativeClientFuture</a>&lt;V&gt;</code></div>
<div class="col-last odd-row-color">
<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>
</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../ProgressiveClientFuture.html" class="type-name-link" title="class in org.apache.qpid.protonj2.client.futures">ProgressiveClientFuture</a>&lt;V&gt;</code></div>
<div class="col-last even-row-color">
<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>
</div>
</div>
<div class="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></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/atomic/AtomicIntegerFieldUpdater.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicIntegerFieldUpdater</a>&lt;<a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientFuture.</span><code><a href="../ClientFuture.html#STATE_FIELD_UPDATER" class="member-name-link">STATE_FIELD_UPDATER</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="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></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><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></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientFutureFactory.</span><code><a href="../ClientFutureFactory.html#createFuture()" class="member-name-link">createFuture</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><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></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientFutureFactory.</span><code><a href="../ClientFutureFactory.html#createFuture(org.apache.qpid.protonj2.client.futures.ClientSynchronization)" class="member-name-link">createFuture</a><wbr>(<a href="../ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures">ClientSynchronization</a>&lt;V&gt;&nbsp;synchronization)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><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></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientFutureFactory.</span><code><a href="../ClientFutureFactory.html#createUnfailableFuture()" class="member-name-link">createUnfailableFuture</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><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></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientFutureFactory.</span><code><a href="../ClientFutureFactory.html#createUnfailableFuture(org.apache.qpid.protonj2.client.futures.ClientSynchronization)" class="member-name-link">createUnfailableFuture</a><wbr>(<a href="../ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures">ClientSynchronization</a>&lt;V&gt;&nbsp;synchronization)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.qpid.protonj2.client.impl">
<h2>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></h2>
<div class="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></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected final <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></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientLinkType.</span><code><a href="../../impl/ClientLinkType.html#closeFuture" class="member-name-link">closeFuture</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><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></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientReceiverLinkType.</span><code><a href="../../impl/ClientReceiverLinkType.html#drainingFuture" class="member-name-link">drainingFuture</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected final <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></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientLinkType.</span><code><a href="../../impl/ClientLinkType.html#openFuture" class="member-name-link">openFuture</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="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></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><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></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientLinkType.</span><code><a href="../../impl/ClientLinkType.html#closeAsync()" class="member-name-link">closeAsync</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><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></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientLinkType.</span><code><a href="../../impl/ClientLinkType.html#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)" class="member-name-link">closeAsync</a><wbr>(<a href="../../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><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></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientLinkType.</span><code><a href="../../impl/ClientLinkType.html#detachAsync()" class="member-name-link">detachAsync</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><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></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientLinkType.</span><code><a href="../../impl/ClientLinkType.html#detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)" class="member-name-link">detachAsync</a><wbr>(<a href="../../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><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></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientLinkType.</span><code><a href="../../impl/ClientLinkType.html#openFuture()" class="member-name-link">openFuture</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><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></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientTrackable.</span><code><a href="../../impl/ClientTrackable.html#settlementFuture()" class="member-name-link">settlementFuture</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<div class="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></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected boolean</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientLinkType.</span><code><a href="../../impl/ClientLinkType.html#notClosedOrFailed(org.apache.qpid.protonj2.client.futures.ClientFuture)" class="member-name-link">notClosedOrFailed</a><wbr>(<a href="../ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;?&gt;&nbsp;request)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientLinkType.</span><code><a href="../../impl/ClientLinkType.html#notClosedOrFailed(org.apache.qpid.protonj2.client.futures.ClientFuture,ProtonType)" class="member-name-link">notClosedOrFailed</a><wbr>(<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></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<div class="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></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><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)" class="member-name-link">ClientOutgoingEnvelope</a><wbr>(<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></div>
<div class="col-last even-row-color">
<div class="block">Create a new In-flight Send instance that is a continuation on an existing delivery.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>