org.apache.sshd.client.future

Interface ConnectFuture

All Superinterfaces:

SshFuture<ConnectFuture>

All Known Implementing Classes:

DefaultConnectFuture

public interface ConnectFuture
extends SshFuture<ConnectFuture>

An SshFuture for asynchronous connections 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.
ClientSession	getSession()
boolean	isCanceled()
boolean	isConnected()
void	setException(Throwable exception) Sets the exception caught due to connection failure and notifies all threads waiting for this future.
void	setSession(ClientSession session) Sets the newly connected session and notifies all threads waiting for this future.
ConnectFuture	verify(long timeout)
ConnectFuture	verify(long count, TimeUnit unit) Wait and verify that connection succeeded within specified timeout

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

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

Method Detail

getSession

ClientSession getSession()

Returns:

The referenced ClientSession

verify

ConnectFuture verify(long count,
                     TimeUnit unit)
              throws IOException

Wait and verify that connection succeeded within specified timeout

Parameters:

count - The number of time units to wait

unit - The TimeUnit for waiting

Returns:

The ConnectFuture

Throws:

IOException - If failed to verify the request on time

verify

ConnectFuture verify(long timeout)
              throws IOException

Parameters:

timeout - The wait timeout in milliseconds

Returns:

The ConnectFuture

Throws:

IOException - If failed to verify the request 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.

isConnected

boolean isConnected()

Returns:

true if the connect operation is finished successfully.

isCanceled

boolean isCanceled()

Returns:

true if the connect operation has been canceled by cancel() method.

setSession

void setSession(ClientSession session)

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.

Parameters:

session - The ClientSession

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.