blob: f52599e47c752c2f66f66d22a6b3f8dff8dddc6f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_66) on Fri Jan 15 14:33:42 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WaitableFuture (Apache Mina SSHD :: Core 1.1.0 API)</title>
<meta name="date" content="2016-01-15">
<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="WaitableFuture (Apache Mina SSHD :: Core 1.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/WaitableFuture.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">
<li><a href="../../../../../org/apache/sshd/common/future/VerifiableFuture.html" title="interface in org.apache.sshd.common.future"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sshd/common/future/WaitableFuture.html" target="_top">Frames</a></li>
<li><a href="WaitableFuture.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.sshd.common.future</div>
<h2 title="Interface WaitableFuture" class="title">Interface WaitableFuture</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/sshd/client/future/AuthFuture.html" title="interface in org.apache.sshd.client.future">AuthFuture</a>, <a href="../../../../../org/apache/sshd/common/future/CloseFuture.html" title="interface in org.apache.sshd.common.future">CloseFuture</a>, <a href="../../../../../org/apache/sshd/client/future/ConnectFuture.html" title="interface in org.apache.sshd.client.future">ConnectFuture</a>, <a href="../../../../../org/apache/sshd/common/io/IoConnectFuture.html" title="interface in org.apache.sshd.common.io">IoConnectFuture</a>, <a href="../../../../../org/apache/sshd/common/io/IoReadFuture.html" title="interface in org.apache.sshd.common.io">IoReadFuture</a>, <a href="../../../../../org/apache/sshd/common/io/IoWriteFuture.html" title="interface in org.apache.sshd.common.io">IoWriteFuture</a>, <a href="../../../../../org/apache/sshd/common/future/KeyExchangeFuture.html" title="interface in org.apache.sshd.common.future">KeyExchangeFuture</a>, <a href="../../../../../org/apache/sshd/client/future/OpenFuture.html" title="interface in org.apache.sshd.client.future">OpenFuture</a>, <a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future">SshFuture</a>&lt;T&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/sshd/common/io/AbstractIoWriteFuture.html" title="class in org.apache.sshd.common.io">AbstractIoWriteFuture</a>, <a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html" title="class in org.apache.sshd.common.future">AbstractSshFuture</a>, <a href="../../../../../org/apache/sshd/common/channel/ChannelAsyncInputStream.IoReadFutureImpl.html" title="class in org.apache.sshd.common.channel">ChannelAsyncInputStream.IoReadFutureImpl</a>, <a href="../../../../../org/apache/sshd/client/future/DefaultAuthFuture.html" title="class in org.apache.sshd.client.future">DefaultAuthFuture</a>, <a href="../../../../../org/apache/sshd/common/future/DefaultCloseFuture.html" title="class in org.apache.sshd.common.future">DefaultCloseFuture</a>, <a href="../../../../../org/apache/sshd/client/future/DefaultConnectFuture.html" title="class in org.apache.sshd.client.future">DefaultConnectFuture</a>, <a href="../../../../../org/apache/sshd/common/future/DefaultKeyExchangeFuture.html" title="class in org.apache.sshd.common.future">DefaultKeyExchangeFuture</a>, <a href="../../../../../org/apache/sshd/client/future/DefaultOpenFuture.html" title="class in org.apache.sshd.client.future">DefaultOpenFuture</a>, <a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html" title="class in org.apache.sshd.common.future">DefaultSshFuture</a>, <a href="../../../../../org/apache/sshd/common/future/DefaultVerifiableSshFuture.html" title="class in org.apache.sshd.common.future">DefaultVerifiableSshFuture</a>, <a href="../../../../../org/apache/sshd/common/channel/IoWriteFutureImpl.html" title="class in org.apache.sshd.common.channel">IoWriteFutureImpl</a>, <a href="../../../../../org/apache/sshd/common/io/nio2/Nio2DefaultIoWriteFuture.html" title="class in org.apache.sshd.common.io.nio2">Nio2DefaultIoWriteFuture</a>, <a href="../../../../../org/apache/sshd/common/session/PendingWriteFuture.html" title="class in org.apache.sshd.common.session">PendingWriteFuture</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">WaitableFuture</span></pre>
<div class="block">Represents an asynchronous operation which one can wait for its completion.
<B>Note:</B> the only thing guaranteed is that if <code>true</code> is returned
from one of the <code>awaitXXX</code> methods then the operation has completed.
However, the <B>caller</B> has to determine whether it was a successful or
failed completion.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await--">await</a></span>()</code>
<div class="block">Wait <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> msec.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await-long-">await</a></span>(long&nbsp;timeoutMillis)</code>
<div class="block">Wait for the asynchronous operation to complete with the specified timeout.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await-long-java.util.concurrent.TimeUnit-">await</a></span>(long&nbsp;timeout,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</code>
<div class="block">Wait for the asynchronous operation to complete with the specified timeout.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly--">awaitUninterruptibly</a></span>()</code>
<div class="block">Wait <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> msec.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly-long-">awaitUninterruptibly</a></span>(long&nbsp;timeoutMillis)</code>
<div class="block">Wait for the asynchronous operation to complete with the specified timeout
uninterruptibly.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly-long-java.util.concurrent.TimeUnit-">awaitUninterruptibly</a></span>(long&nbsp;timeout,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</code>
<div class="block">Wait for the asynchronous operation to complete with the specified timeout
uninterruptibly.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#isDone--">isDone</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="await--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>await</h4>
<pre>boolean&nbsp;await()
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Wait <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> msec. for the asynchronous operation to complete.
The attached listeners will be notified when the operation is
completed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the operation is completed.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if failed - specifically <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InterruptedIOException.html?is-external=true" title="class or interface in java.io"><code>InterruptedIOException</code></a>
if waiting was interrupted</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await-long-"><code>await(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="await-long-java.util.concurrent.TimeUnit-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>await</h4>
<pre>boolean&nbsp;await(long&nbsp;timeout,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Wait for the asynchronous operation to complete with the specified timeout.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - The number of time units to wait</dd>
<dd><code>unit</code> - The <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent"><code>TimeUnit</code></a> for waiting</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the operation is completed.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if failed - specifically <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InterruptedIOException.html?is-external=true" title="class or interface in java.io"><code>InterruptedIOException</code></a>
if waiting was interrupted</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await-long-"><code>await(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="await-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>await</h4>
<pre>boolean&nbsp;await(long&nbsp;timeoutMillis)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Wait for the asynchronous operation to complete with the specified timeout.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeoutMillis</code> - Wait time in milliseconds</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the operation is completed.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if failed - specifically <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InterruptedIOException.html?is-external=true" title="class or interface in java.io"><code>InterruptedIOException</code></a>
if waiting was interrupted</dd>
</dl>
</li>
</ul>
<a name="awaitUninterruptibly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>awaitUninterruptibly</h4>
<pre>boolean&nbsp;awaitUninterruptibly()</pre>
<div class="block">Wait <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Long.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Long.MAX_VALUE</code></a> msec. for the asynchronous operation to complete
uninterruptibly. The attached listeners will be notified when the operation is
completed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the operation is completed.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly-long-"><code>awaitUninterruptibly(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="awaitUninterruptibly-long-java.util.concurrent.TimeUnit-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>awaitUninterruptibly</h4>
<pre>boolean&nbsp;awaitUninterruptibly(long&nbsp;timeout,
<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</pre>
<div class="block">Wait for the asynchronous operation to complete with the specified timeout
uninterruptibly.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - The number of time units to wait</dd>
<dd><code>unit</code> - The <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent"><code>TimeUnit</code></a> for waiting</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the operation is completed.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly-long-"><code>awaitUninterruptibly(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="awaitUninterruptibly-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>awaitUninterruptibly</h4>
<pre>boolean&nbsp;awaitUninterruptibly(long&nbsp;timeoutMillis)</pre>
<div class="block">Wait for the asynchronous operation to complete with the specified timeout
uninterruptibly.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeoutMillis</code> - Wait time in milliseconds</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the operation is finished.</dd>
</dl>
</li>
</ul>
<a name="isDone--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isDone</h4>
<pre>boolean&nbsp;isDone()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the asynchronous operation is completed. <B>Note:</B>
it is up to the <B>caller</B> to determine whether it was a successful or
failed completion.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/WaitableFuture.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">
<li><a href="../../../../../org/apache/sshd/common/future/VerifiableFuture.html" title="interface in org.apache.sshd.common.future"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sshd/common/future/WaitableFuture.html" target="_top">Frames</a></li>
<li><a href="WaitableFuture.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>