Google Git
Sign in
apache / mina-site / refs/heads/sshd-apidocs / . / org / apache / sshd / common / future / AbstractSshFuture.html
blob: 2fc130c792699e32433db10f680d842d1721de84 [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>AbstractSshFuture (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="AbstractSshFuture (Apache Mina SSHD :: Core 1.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":6,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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/AbstractSshFuture.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/sshd/common/future/CloseFuture.html" title="interface in org.apache.sshd.common.future"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sshd/common/future/AbstractSshFuture.html" target="_top">Frames</a></li>
<li><a href="AbstractSshFuture.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><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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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="Class AbstractSshFuture" class="title">Class AbstractSshFuture&lt;T extends <a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future">SshFuture</a>&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html" title="class in org.apache.sshd.common.util.logging">org.apache.sshd.common.util.logging.AbstractLoggingBean</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sshd.common.future.AbstractSshFuture&lt;T&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>T</code> - Type of future</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future">SshFuture</a>&lt;T&gt;, <a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html" title="interface in org.apache.sshd.common.future">WaitableFuture</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html" title="class in org.apache.sshd.common.future">DefaultSshFuture</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractSshFuture&lt;T extends <a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future">SshFuture</a>&gt;</span>
extends <a href="../../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html" title="class in org.apache.sshd.common.util.logging">AbstractLoggingBean</a>
implements <a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future">SshFuture</a>&lt;T&gt;</pre>
<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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#CANCELED">CANCELED</a></span></code>
<div class="block">A default value to indicate the future has been canceled</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.sshd.common.util.logging.AbstractLoggingBean">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.sshd.common.util.logging.<a href="../../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html" title="class in org.apache.sshd.common.util.logging">AbstractLoggingBean</a></h3>
<code><a href="../../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html#log">log</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#AbstractSshFuture--">AbstractSshFuture</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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><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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/sshd/common/future/SshFutureListener.html" title="interface in org.apache.sshd.common.future">SshFutureListener</a>&lt;<a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html" title="type parameter in AbstractSshFuture">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#asListener-java.lang.Object-">asListener</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html" title="type parameter in AbstractSshFuture">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#asT--">asT</a></span>()</code>&nbsp;</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/AbstractSshFuture.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="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.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="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.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="i5" class="rowColor">
<td class="colFirst"><code>protected abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#await0-long-boolean-">await0</a></span>(long&nbsp;timeoutMillis,
boolean&nbsp;interruptable)</code>
<div class="block">Wait for the Future to be ready.</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/AbstractSshFuture.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="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.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="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.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="i9" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#notifyListener-org.apache.sshd.common.future.SshFutureListener-">notifyListener</a></span>(<a href="../../../../../org/apache/sshd/common/future/SshFutureListener.html" title="interface in org.apache.sshd.common.future">SshFutureListener</a>&lt;<a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html" title="type parameter in AbstractSshFuture">T</a>&gt;&nbsp;l)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected &lt;R&gt;&nbsp;R</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#verifyResult-java.lang.Class-long-">verifyResult</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends R&gt;&nbsp;expectedType,
long&nbsp;timeout)</code>
<div class="block">Waits (interruptible) for the specified timeout (msec.) and then checks
the result:</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.future.SshFuture">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.future.<a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future">SshFuture</a></h3>
<code><a href="../../../../../org/apache/sshd/common/future/SshFuture.html#addListener-org.apache.sshd.common.future.SshFutureListener-">addListener</a>, <a href="../../../../../org/apache/sshd/common/future/SshFuture.html#removeListener-org.apache.sshd.common.future.SshFutureListener-">removeListener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.future.WaitableFuture">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.common.future.<a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html" title="interface in org.apache.sshd.common.future">WaitableFuture</a></h3>
<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#isDone--">isDone</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CANCELED">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CANCELED</h4>
<pre>protected static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> CANCELED</pre>
<div class="block">A default value to indicate the future has been canceled</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractSshFuture--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractSshFuture</h4>
<pre>protected&nbsp;AbstractSshFuture()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ 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>public&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await--">WaitableFuture</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await--">await</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html" title="interface in org.apache.sshd.common.future">WaitableFuture</a></code></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>WaitableFuture.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>public&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await-long-java.util.concurrent.TimeUnit-">WaitableFuture</a></code></span></div>
<div class="block">Wait for the asynchronous operation to complete with the specified timeout.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await-long-java.util.concurrent.TimeUnit-">await</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html" title="interface in org.apache.sshd.common.future">WaitableFuture</a></code></dd>
<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>WaitableFuture.await(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="await-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>await</h4>
<pre>public&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await-long-">WaitableFuture</a></code></span></div>
<div class="block">Wait for the asynchronous operation to complete with the specified timeout.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await-long-">await</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html" title="interface in org.apache.sshd.common.future">WaitableFuture</a></code></dd>
<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>public&nbsp;boolean&nbsp;awaitUninterruptibly()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly--">WaitableFuture</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly--">awaitUninterruptibly</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html" title="interface in org.apache.sshd.common.future">WaitableFuture</a></code></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>WaitableFuture.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>public&nbsp;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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly-long-java.util.concurrent.TimeUnit-">WaitableFuture</a></code></span></div>
<div class="block">Wait for the asynchronous operation to complete with the specified timeout
uninterruptibly.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly-long-java.util.concurrent.TimeUnit-">awaitUninterruptibly</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html" title="interface in org.apache.sshd.common.future">WaitableFuture</a></code></dd>
<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>WaitableFuture.awaitUninterruptibly(long)</code></a></dd>
</dl>
</li>
</ul>
<a name="awaitUninterruptibly-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>awaitUninterruptibly</h4>
<pre>public&nbsp;boolean&nbsp;awaitUninterruptibly(long&nbsp;timeoutMillis)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly-long-">WaitableFuture</a></code></span></div>
<div class="block">Wait for the asynchronous operation to complete with the specified timeout
uninterruptibly.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly-long-">awaitUninterruptibly</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html" title="interface in org.apache.sshd.common.future">WaitableFuture</a></code></dd>
<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="verifyResult-java.lang.Class-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyResult</h4>
<pre>protected&nbsp;&lt;R&gt;&nbsp;R&nbsp;verifyResult(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends R&gt;&nbsp;expectedType,
long&nbsp;timeout)
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"><P>Waits (interruptible) for the specified timeout (msec.) and then checks
the result:</P>
<UL>
<LI><P>
If result is <code>null</code> then timeout is assumed to have expired - throw
an appropriate <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>
</P></LI>
<LI><P>
If the result is of the expected type, then cast and return it
</P></LI>
<LI><P>
If the result is an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> then re-throw it
</P></LI>
<LI><P>
If the result is a <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang"><code>Throwable</code></a> then throw an <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>
whose cause is the original exception
</P></LI>
<LI><P>
Otherwise (should never happen), throw a <a href="http://docs.oracle.com/javase/7/docs/api/java/io/StreamCorruptedException.html?is-external=true" title="class or interface in java.io"><code>StreamCorruptedException</code></a>
with the name of the result type
</P></LI>
</UL></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>R</code> - The generic result type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expectedType</code> - The expected result type</dd>
<dd><code>timeout</code> - The timeout (millis) to wait for a result</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The (never <code>null</code>) result</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 to retrieve the expected result on time</dd>
</dl>
</li>
</ul>
<a name="await0-long-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>await0</h4>
<pre>protected abstract&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;await0(long&nbsp;timeoutMillis,
boolean&nbsp;interruptable)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InterruptedIOException.html?is-external=true" title="class or interface in java.io">InterruptedIOException</a></pre>
<div class="block">Wait for the Future to be ready. If the requested delay is 0 or
negative, this method returns immediately.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeoutMillis</code> - The delay we will wait for the Future to be ready</dd>
<dd><code>interruptable</code> - Tells if the wait can be interrupted or not.
If <code>true</code> and the thread is interrupted then an <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>
is thrown.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The non-<code>null</code> result object if the Future is ready,
<code>null</code> if the timeout expired and no result was received</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InterruptedIOException.html?is-external=true" title="class or interface in java.io">InterruptedIOException</a></code> - If the thread has been interrupted
when it's not allowed.</dd>
</dl>
</li>
</ul>
<a name="asListener-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asListener</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/sshd/common/future/SshFutureListener.html" title="interface in org.apache.sshd.common.future">SshFutureListener</a>&lt;<a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html" title="type parameter in AbstractSshFuture">T</a>&gt;&nbsp;asListener(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;o)</pre>
</li>
</ul>
<a name="notifyListener-org.apache.sshd.common.future.SshFutureListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyListener</h4>
<pre>protected&nbsp;void&nbsp;notifyListener(<a href="../../../../../org/apache/sshd/common/future/SshFutureListener.html" title="interface in org.apache.sshd.common.future">SshFutureListener</a>&lt;<a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html" title="type parameter in AbstractSshFuture">T</a>&gt;&nbsp;l)</pre>
</li>
</ul>
<a name="asT--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>asT</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html" title="type parameter in AbstractSshFuture">T</a>&nbsp;asT()</pre>
</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/AbstractSshFuture.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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/sshd/common/future/CloseFuture.html" title="interface in org.apache.sshd.common.future"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sshd/common/future/AbstractSshFuture.html" target="_top">Frames</a></li>
<li><a href="AbstractSshFuture.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><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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>