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

Modifier and Type	Method and Description
void	cancel() Cancels the connection attempt and notifies all threads waiting for this future.
Throwable	getException() Returns the cause of the connection failure.
boolean	isCanceled()
boolean	isOpened()
void	setException(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.
void	verify() Wait and verify that the channel has been successfully opened.
void	verify(long timeoutMillis) Wait and verify that the channel has been successfully opened.
void	verify(long timeout, TimeUnit unit) Wait and verify that the channel has been successfully opened.

Methods inherited from interface org.apache.sshd.common.future.SshFuture

addListener, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, isDone, removeListener

Method Detail

verify

void verify()
     throws IOException

Wait and verify that the channel has been successfully opened.

Throws:

IOException - if the action failed for any reason

verify

void verify(long timeout,
            TimeUnit unit)
     throws IOException

Wait and verify that the channel has been successfully opened.

Parameters:

timeout - The number of time units to wait

unit - The wait TimeUnit

Throws:

IOException - If failed to verify successfully on time

verify

void verify(long timeoutMillis)
     throws IOException

Wait and verify that the channel has been successfully opened.

Parameters:

timeoutMillis - Wait timeout in milliseconds

Throws:

IOException - If failed to verify successfully on time

getException

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(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.