| <!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:41 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>OpenFuture (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="OpenFuture (Apache Mina SSHD :: Core 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/OpenFuture.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/client/future/DefaultOpenFuture.html" title="class in org.apache.sshd.client.future"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/client/future/OpenFuture.html" target="_top">Frames</a></li> |
| <li><a href="OpenFuture.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.client.future</div> |
| <h2 title="Interface OpenFuture" class="title">Interface OpenFuture</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future">SshFuture</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/VerifiableFuture.html" title="interface in org.apache.sshd.common.future">VerifiableFuture</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/WaitableFuture.html" title="interface in org.apache.sshd.common.future">WaitableFuture</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/sshd/client/future/DefaultOpenFuture.html" title="class in org.apache.sshd.client.future">DefaultOpenFuture</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">OpenFuture</span> |
| extends <a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future">SshFuture</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/VerifiableFuture.html" title="interface in org.apache.sshd.common.future">VerifiableFuture</a><<a href="../../../../../org/apache/sshd/client/future/OpenFuture.html" title="interface in org.apache.sshd.client.future">OpenFuture</a>></pre> |
| <div class="block">An <a href="../../../../../org/apache/sshd/common/future/SshFuture.html" title="interface in org.apache.sshd.common.future"><code>SshFuture</code></a> for asynchronous channel opening requests.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/future/OpenFuture.html#cancel--">cancel</a></span>()</code> |
| <div class="block">Cancels the connection attempt and notifies all threads waiting for |
| this future.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/future/OpenFuture.html#getException--">getException</a></span>()</code> |
| <div class="block">Returns the cause of the connection failure.</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/client/future/OpenFuture.html#isCanceled--">isCanceled</a></span>()</code> </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/client/future/OpenFuture.html#isOpened--">isOpened</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/future/OpenFuture.html#setException-java.lang.Throwable-">setException</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> exception)</code> |
| <div class="block">Sets the exception caught due to connection failure and notifies all |
| threads waiting for this future.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/client/future/OpenFuture.html#setOpened--">setOpened</a></span>()</code> |
| <div class="block">Sets the newly connected session and notifies all threads waiting for |
| this future.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.future.SshFuture"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface 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 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#await--">await</a>, <a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await-long-">await</a>, <a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#await-long-java.util.concurrent.TimeUnit-">await</a>, <a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly--">awaitUninterruptibly</a>, <a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly-long-">awaitUninterruptibly</a>, <a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#awaitUninterruptibly-long-java.util.concurrent.TimeUnit-">awaitUninterruptibly</a>, <a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#isDone--">isDone</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.common.future.VerifiableFuture"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.sshd.common.future.<a href="../../../../../org/apache/sshd/common/future/VerifiableFuture.html" title="interface in org.apache.sshd.common.future">VerifiableFuture</a></h3> |
| <code><a href="../../../../../org/apache/sshd/common/future/VerifiableFuture.html#verify--">verify</a>, <a href="../../../../../org/apache/sshd/common/future/VerifiableFuture.html#verify-long-">verify</a>, <a href="../../../../../org/apache/sshd/common/future/VerifiableFuture.html#verify-long-java.util.concurrent.TimeUnit-">verify</a></code></li> |
| </ul> |
| </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="getException--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getException</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> getException()</pre> |
| <div class="block">Returns the cause of the connection failure.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>null</code> if the connect operation is not finished yet, |
| or if the connection attempt is successful (use <a href="../../../../../org/apache/sshd/common/future/WaitableFuture.html#isDone--"><code>WaitableFuture.isDone()</code></a> to |
| distinguish between the two).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isOpened--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOpened</h4> |
| <pre>boolean isOpened()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the connect operation is finished successfully.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCanceled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCanceled</h4> |
| <pre>boolean isCanceled()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the connect operation has been canceled by |
| <a href="../../../../../org/apache/sshd/client/future/OpenFuture.html#cancel--"><code>cancel()</code></a> method.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOpened--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOpened</h4> |
| <pre>void setOpened()</pre> |
| <div class="block">Sets the newly connected session and notifies all threads waiting for |
| this future. This method is invoked by SSHD internally. Please do not |
| call this method directly.</div> |
| </li> |
| </ul> |
| <a name="setException-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setException</h4> |
| <pre>void setException(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> exception)</pre> |
| <div class="block">Sets the exception caught due to connection failure and notifies all |
| threads waiting for this future. This method is invoked by SSHD |
| internally. Please do not call this method directly.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>exception</code> - The caught <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cancel--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cancel</h4> |
| <pre>void cancel()</pre> |
| <div class="block">Cancels the connection attempt and notifies all threads waiting for |
| this future.</div> |
| </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/OpenFuture.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/client/future/DefaultOpenFuture.html" title="class in org.apache.sshd.client.future"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/client/future/OpenFuture.html" target="_top">Frames</a></li> |
| <li><a href="OpenFuture.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
