| <!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>DefaultSshFuture (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="DefaultSshFuture (Apache Mina SSHD :: Core 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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"; |
| </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/DefaultSshFuture.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/DefaultKeyExchangeFuture.html" title="class in org.apache.sshd.common.future"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sshd/common/future/DefaultVerifiableSshFuture.html" title="class in org.apache.sshd.common.future"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/common/future/DefaultSshFuture.html" target="_top">Frames</a></li> |
| <li><a href="DefaultSshFuture.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.sshd.common.future.AbstractSshFuture">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 DefaultSshFuture" class="title">Class DefaultSshFuture<T extends <a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future">SshFuture</a>></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><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html" title="class in org.apache.sshd.common.future">org.apache.sshd.common.future.AbstractSshFuture</a><T></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.sshd.common.future.DefaultSshFuture<T></li> |
| </ul> |
| </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><T>, <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/DefaultCloseFuture.html" title="class in org.apache.sshd.common.future">DefaultCloseFuture</a>, <a href="../../../../../org/apache/sshd/common/future/DefaultVerifiableSshFuture.html" title="class in org.apache.sshd.common.future">DefaultVerifiableSshFuture</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">DefaultSshFuture<T extends <a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future">SshFuture</a>></span> |
| extends <a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html" title="class in org.apache.sshd.common.future">AbstractSshFuture</a><T></pre> |
| <div class="block">A default implementation of <a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future"><code>SshFuture</code></a>.</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"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.sshd.common.future.AbstractSshFuture"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.sshd.common.future.<a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html" title="class in org.apache.sshd.common.future">AbstractSshFuture</a></h3> |
| <code><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#CANCELED">CANCELED</a></code></li> |
| </ul> |
| <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 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"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html#DefaultSshFuture-java.lang.Object-">DefaultSshFuture</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> lock)</code> |
| <div class="block">Creates a new instance.</div> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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><a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html" title="type parameter in DefaultSshFuture">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html#addListener-org.apache.sshd.common.future.SshFutureListener-">addListener</a></span>(<a href="../../../../../org/apache/sshd/common/future/SshFutureListener.html" title="interface in org.apache.sshd.common.future">SshFutureListener</a><<a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html" title="type parameter in DefaultSshFuture">T</a>> listener)</code> |
| <div class="block">Adds an event <tt>listener</tt> which is notified when |
| this future is completed.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected <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/DefaultSshFuture.html#await0-long-boolean-">await0</a></span>(long timeoutMillis, |
| boolean interruptable)</code> |
| <div class="block">Wait for the Future to be ready.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html#cancel--">cancel</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><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/DefaultSshFuture.html#getValue--">getValue</a></span>()</code> </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/DefaultSshFuture.html#isCanceled--">isCanceled</a></span>()</code> </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/DefaultSshFuture.html#isDone--">isDone</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html#notifyListeners--">notifyListeners</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html" title="type parameter in DefaultSshFuture">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html#removeListener-org.apache.sshd.common.future.SshFutureListener-">removeListener</a></span>(<a href="../../../../../org/apache/sshd/common/future/SshFutureListener.html" title="interface in org.apache.sshd.common.future">SshFutureListener</a><<a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html" title="type parameter in DefaultSshFuture">T</a>> listener)</code> |
| <div class="block">Removes an existing event <tt>listener</tt> so it won't be notified when |
| the future is completed.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html#setValue-java.lang.Object-">setValue</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> newValue)</code> |
| <div class="block">Sets the result of the asynchronous operation, and mark it as finished.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.future.AbstractSshFuture"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.sshd.common.future.<a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html" title="class in org.apache.sshd.common.future">AbstractSshFuture</a></h3> |
| <code><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#asListener-java.lang.Object-">asListener</a>, <a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#asT--">asT</a>, <a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#await--">await</a>, <a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#await-long-">await</a>, <a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#await-long-java.util.concurrent.TimeUnit-">await</a>, <a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#awaitUninterruptibly--">awaitUninterruptibly</a>, <a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#awaitUninterruptibly-long-">awaitUninterruptibly</a>, <a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#awaitUninterruptibly-long-java.util.concurrent.TimeUnit-">awaitUninterruptibly</a>, <a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#notifyListener-org.apache.sshd.common.future.SshFutureListener-">notifyListener</a>, <a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#verifyResult-java.lang.Class-long-">verifyResult</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="DefaultSshFuture-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DefaultSshFuture</h4> |
| <pre>public DefaultSshFuture(<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> lock)</pre> |
| <div class="block">Creates a new instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lock</code> - A synchronization object for locking access - if <code>null</code> |
| then synchronization occurs on <code>this</code> instance</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="await0-long-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>await0</h4> |
| <pre>protected <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> await0(long timeoutMillis, |
| boolean 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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#await0-long-boolean-">AbstractSshFuture</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/sshd/common/future/AbstractSshFuture.html#await0-long-boolean-">await0</a></code> in class <code><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/future/DefaultSshFuture.html" title="type parameter in DefaultSshFuture">T</a> extends <a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future">SshFuture</a>></code></dd> |
| <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="isDone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDone</h4> |
| <pre>public boolean 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> |
| <a name="setValue-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValue</h4> |
| <pre>public void setValue(<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> newValue)</pre> |
| <div class="block">Sets the result of the asynchronous operation, and mark it as finished.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>newValue</code> - The operation result</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre>public <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> getValue()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The result of the asynchronous operation - or <code>null</code> |
| if none set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addListener-org.apache.sshd.common.future.SshFutureListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addListener</h4> |
| <pre>public <a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html" title="type parameter in DefaultSshFuture">T</a> addListener(<a href="../../../../../org/apache/sshd/common/future/SshFutureListener.html" title="interface in org.apache.sshd.common.future">SshFutureListener</a><<a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html" title="type parameter in DefaultSshFuture">T</a>> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/sshd/common/future/SshFuture.html#addListener-org.apache.sshd.common.future.SshFutureListener-">SshFuture</a></code></span></div> |
| <div class="block">Adds an event <tt>listener</tt> which is notified when |
| this future is completed. If the listener is added |
| after the completion, the listener is directly notified.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - The <a href="../../../../../org/apache/sshd/common/future/SshFutureListener.html" title="interface in org.apache.sshd.common.future"><code>SshFutureListener</code></a> instance to add</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The future instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeListener-org.apache.sshd.common.future.SshFutureListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeListener</h4> |
| <pre>public <a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html" title="type parameter in DefaultSshFuture">T</a> removeListener(<a href="../../../../../org/apache/sshd/common/future/SshFutureListener.html" title="interface in org.apache.sshd.common.future">SshFutureListener</a><<a href="../../../../../org/apache/sshd/common/future/DefaultSshFuture.html" title="type parameter in DefaultSshFuture">T</a>> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/sshd/common/future/SshFuture.html#removeListener-org.apache.sshd.common.future.SshFutureListener-">SshFuture</a></code></span></div> |
| <div class="block">Removes an existing event <tt>listener</tt> so it won't be notified when |
| the future is completed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - The <a href="../../../../../org/apache/sshd/common/future/SshFutureListener.html" title="interface in org.apache.sshd.common.future"><code>SshFutureListener</code></a> instance to remove</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The future instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="notifyListeners--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>notifyListeners</h4> |
| <pre>protected void notifyListeners()</pre> |
| </li> |
| </ul> |
| <a name="isCanceled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCanceled</h4> |
| <pre>public boolean isCanceled()</pre> |
| </li> |
| </ul> |
| <a name="cancel--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cancel</h4> |
| <pre>public void cancel()</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/DefaultSshFuture.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/DefaultKeyExchangeFuture.html" title="class in org.apache.sshd.common.future"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sshd/common/future/DefaultVerifiableSshFuture.html" title="class in org.apache.sshd.common.future"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/common/future/DefaultSshFuture.html" target="_top">Frames</a></li> |
| <li><a href="DefaultSshFuture.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.sshd.common.future.AbstractSshFuture">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2008–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
