blob: 6ecb32e77ffa4b7d71f2782b20504b1bd2332dad [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 -->
<title>ConservativeClientFuture (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="ConservativeClientFuture (Qpid ProtonJ2 Parent 1.0.0-M1 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":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";
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/ConservativeClientFuture.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.client.futures</a></div>
<h2 title="Class ConservativeClientFuture" class="title">Class ConservativeClientFuture&lt;V&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">org.apache.qpid.protonj2.client.futures.ClientFuture</a>&lt;V&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.qpid.protonj2.client.futures.ConservativeClientFuture&lt;V&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>V</code> - The type that result from completion of this Future</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.util.concurrent.Future&lt;V&gt;</code>, <code><a href="AsyncResult.html" title="interface in org.apache.qpid.protonj2.client.futures">AsyncResult</a>&lt;V&gt;</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">ConservativeClientFuture&lt;V&gt;</span>
extends <a href="ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;V&gt;</pre>
<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>
</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.futures.ClientFuture">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;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></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ConservativeClientFuture</a></span>()</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.qpid.protonj2.client.futures.ClientSynchronization)">ConservativeClientFuture</a></span>&#8203;(<a href="ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures">ClientSynchronization</a>&lt;<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>&gt;&nbsp;synchronization)</code></th>
<td class="colLast">
<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>
</td>
</tr>
</table>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get()">get</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(long,java.util.concurrent.TimeUnit)">get</a></span>&#8203;(long&nbsp;amount,
java.util.concurrent.TimeUnit&nbsp;unit)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.client.futures.ClientFuture">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ConservativeClientFuture</h4>
<pre>public&nbsp;ConservativeClientFuture()</pre>
<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>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.qpid.protonj2.client.futures.ClientSynchronization)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConservativeClientFuture</h4>
<pre>public&nbsp;ConservativeClientFuture&#8203;(<a href="ClientSynchronization.html" title="interface in org.apache.qpid.protonj2.client.futures">ClientSynchronization</a>&lt;<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>&gt;&nbsp;synchronization)</pre>
<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>
<dt><span class="paramLabel">Parameters:</span></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>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="get(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature">public&nbsp;<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>&nbsp;get&#8203;(long&nbsp;amount,
java.util.concurrent.TimeUnit&nbsp;unit)
throws java.lang.InterruptedException,
java.util.concurrent.ExecutionException,
java.util.concurrent.TimeoutException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>get</code>&nbsp;in interface&nbsp;<code>java.util.concurrent.Future&lt;<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientFuture.html#get(long,java.util.concurrent.TimeUnit)">get</a></code>&nbsp;in class&nbsp;<code><a href="ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code></dd>
<dd><code>java.util.concurrent.ExecutionException</code></dd>
<dd><code>java.util.concurrent.TimeoutException</code></dd>
</dl>
</li>
</ul>
<a id="get()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>get</h4>
<pre class="methodSignature">public&nbsp;<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>&nbsp;get()
throws java.lang.InterruptedException,
java.util.concurrent.ExecutionException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>get</code>&nbsp;in interface&nbsp;<code>java.util.concurrent.Future&lt;<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientFuture.html#get()">get</a></code>&nbsp;in class&nbsp;<code><a href="ClientFuture.html" title="class in org.apache.qpid.protonj2.client.futures">ClientFuture</a>&lt;<a href="ConservativeClientFuture.html" title="type parameter in ConservativeClientFuture">V</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code></dd>
<dd><code>java.util.concurrent.ExecutionException</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/ConservativeClientFuture.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&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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>