OpenFuture

All Superinterfaces:

SshFuture<OpenFuture>, VerifiableFuture<OpenFuture>, WaitableFuture

All Known Implementing Classes:

DefaultOpenFuture
```
public interface OpenFuture
extends SshFuture<OpenFuture>, VerifiableFuture<OpenFuture>
```
An SshFuture for asynchronous channel opening requests.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cancel()`	Cancels the connection attempt and notifies all threads waiting for this future.
`java.lang.Throwable`	`getException()`	Returns the cause of the connection failure.
`boolean`	`isCanceled()`
`boolean`	`isOpened()`
`void`	`setException(java.lang.Throwable exception)`	Sets the exception caught due to connection failure and notifies all threads waiting for this future.
`void`	`setOpened()`	Sets the newly connected session and notifies all threads waiting for this future.

Methods inherited from interface org.apache.sshd.common.future.SshFuture
addListener, removeListener

Methods inherited from interface org.apache.sshd.common.future.VerifiableFuture
verify, verify, verify, verify

Methods inherited from interface org.apache.sshd.common.future.WaitableFuture
await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone

- Method Detail
  - getException
```
java.lang.Throwable getException()
```
    Returns the cause of the connection failure.
    
    Returns:
    
    null if the connect operation is not finished yet, or if the connection attempt is successful (use WaitableFuture.isDone() to distinguish between the two).
  - isOpened
```
boolean isOpened()
```
    Returns:
    
    true if the connect operation is finished successfully.
  - isCanceled
```
boolean isCanceled()
```
    Returns:
    
    true if the connect operation has been canceled by cancel() method.
  - setOpened
```
void setOpened()
```
    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.
  - setException
```
void setException(java.lang.Throwable exception)
```
    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.
    
    Parameters:
    
    exception - The caught Throwable
  - cancel
```
void cancel()
```
    Cancels the connection attempt and notifies all threads waiting for this future.