| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ConservativeClientFuture (Qpid ProtonJ2 Parent 1.0.0-M18 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="declaration: package: org.apache.qpid.protonj2.client.futures, class: ConservativeClientFuture"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </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 class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ConservativeClientFuture.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.client.futures</a></div> |
| <h1 title="Class ConservativeClientFuture" class="title">Class ConservativeClientFuture<V></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">org.apache.qpid.protonj2.client.futures.ClientFuture</a><V> |
| <div class="inheritance">org.apache.qpid.protonj2.client.futures.ConservativeClientFuture<V></div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>V</code> - The type that result from completion of this Future</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><V></code>, <code><a href="AsyncResult.html" title="interface in org.apache.qpid.protonj2.client.futures">AsyncResult</a><V></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ConservativeClientFuture<V></span> |
| <span class="extends-implements">extends <a href="ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><V></span></div> |
| <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> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.qpid.protonj2.client.futures.ClientFuture">Fields inherited from class org.apache.qpid.protonj2.client.futures.<a href="ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a></h3> |
| <code><a href="ClientFuture.html#CANCELLED">CANCELLED</a>, <a href="ClientFuture.html#COMPLETING">COMPLETING</a>, <a href="ClientFuture.html#error">error</a>, <a href="ClientFuture.html#FAILURE">FAILURE</a>, <a href="ClientFuture.html#INCOMPLETE">INCOMPLETE</a>, <a href="ClientFuture.html#result">result</a>, <a href="ClientFuture.html#STATE_FIELD_UPDATER">STATE_FIELD_UPDATER</a>, <a href="ClientFuture.html#SUCCESS">SUCCESS</a>, <a href="ClientFuture.html#synchronization">synchronization</a>, <a href="ClientFuture.html#waiting">waiting</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ConservativeClientFuture</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Create a new <a href="ConservativeClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures"><code>ConservativeClientFuture</code></a> instance with no assigned <a href="ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures"><code>ClientSynchronization</code></a>.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.qpid.protonj2.client.futures.ClientSynchronization)" class="member-name-link">ConservativeClientFuture</a><wbr>(<a href="ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures">ClientSynchronization</a><<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>> synchronization)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Create a new <a href="ConservativeClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures"><code>ConservativeClientFuture</code></a> instance with the assigned <a href="ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures"><code>ClientSynchronization</code></a>.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <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 method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get()" class="member-name-link">get</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(long,java.util.concurrent.TimeUnit)" class="member-name-link">get</a><wbr>(long amount, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.client.futures.ClientFuture">Methods inherited from class org.apache.qpid.protonj2.client.futures.<a href="ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a></h3> |
| <code><a href="ClientFuture.html#cancel(boolean)">cancel</a>, <a href="ClientFuture.html#complete(V)">complete</a>, <a href="ClientFuture.html#failed(org.apache.qpid.protonj2.client.exceptions.ClientException)">failed</a>, <a href="ClientFuture.html#getResult()">getResult</a>, <a href="ClientFuture.html#getState()">getState</a>, <a href="ClientFuture.html#isCancelled()">isCancelled</a>, <a href="ClientFuture.html#isComplete()">isComplete</a>, <a href="ClientFuture.html#isDone()">isDone</a>, <a href="ClientFuture.html#isFailed()">isFailed</a>, <a href="ClientFuture.html#isNotComplete()">isNotComplete</a>, <a href="ClientFuture.html#tryCancelTask()">tryCancelTask</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>ConservativeClientFuture</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ConservativeClientFuture</span>()</div> |
| <div class="block">Create a new <a href="ConservativeClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures"><code>ConservativeClientFuture</code></a> instance with no assigned <a href="ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures"><code>ClientSynchronization</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.qpid.protonj2.client.futures.ClientSynchronization)"> |
| <h3>ConservativeClientFuture</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ConservativeClientFuture</span><wbr><span class="parameters">(<a href="ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures">ClientSynchronization</a><<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>> synchronization)</span></div> |
| <div class="block">Create a new <a href="ConservativeClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures"><code>ConservativeClientFuture</code></a> instance with the assigned <a href="ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures"><code>ClientSynchronization</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>synchronization</code> - the <a href="ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures"><code>ClientSynchronization</code></a> that should be notified upon completion of this future.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="get(long,java.util.concurrent.TimeUnit)"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a></span> <span class="element-name">get</span><wbr><span class="parameters">(long amount, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ExecutionException.html" title="class or interface in java.util.concurrent" class="external-link">ExecutionException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeoutException.html" title="class or interface in java.util.concurrent" class="external-link">TimeoutException</a></span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get(long,java.util.concurrent.TimeUnit)" title="class or interface in java.util.concurrent" class="external-link">get</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ClientFuture.html#get(long,java.util.concurrent.TimeUnit)">get</a></code> in class <code><a href="ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ExecutionException.html" title="class or interface in java.util.concurrent" class="external-link">ExecutionException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeoutException.html" title="class or interface in java.util.concurrent" class="external-link">TimeoutException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get()"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a></span> <span class="element-name">get</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ExecutionException.html" title="class or interface in java.util.concurrent" class="external-link">ExecutionException</a></span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html#get()" title="class or interface in java.util.concurrent" class="external-link">get</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ClientFuture.html#get()">get</a></code> in class <code><a href="ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a><<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ExecutionException.html" title="class or interface in java.util.concurrent" class="external-link">ExecutionException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
