org.apache.sshd.client.future
Interface OpenFuture

All Superinterfaces:

SshFuture<OpenFuture>

All Known Implementing Classes:

DefaultOpenFuture

public interface OpenFuture
extends SshFuture<OpenFuture>

An SshFuture for asynchronous channel opening requests.

Author:

Apache MINA SSHD Project

Method Summary

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() Returns true if the connect operation has been canceled by cancel() method.
boolean	isOpened() Returns true if the connect operation is finished successfully.
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, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, isDone, removeListener

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.

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.

cancel

void cancel()

Cancels the connection attempt and notifies all threads waiting for this future.