org.apache.sshd.common.io.nio2

Class Nio2Connector.DefaultIoConnectFuture

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.future.AbstractSshFuture<T>

org.apache.sshd.common.future.DefaultSshFuture<IoConnectFuture>

org.apache.sshd.common.io.nio2.Nio2Connector.DefaultIoConnectFuture

All Implemented Interfaces:

SshFuture<IoConnectFuture>, WaitableFuture, IoConnectFuture

Enclosing class:

Nio2Connector

public static class Nio2Connector.DefaultIoConnectFuture
extends DefaultSshFuture<IoConnectFuture>
implements IoConnectFuture

Field Summary

Fields inherited from class org.apache.sshd.common.future.AbstractSshFuture

CANCELED, debugEnabled, traceEnabled

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor and Description
DefaultIoConnectFuture(Object id, Object lock)

Method Summary

Modifier and Type	Method and Description
Throwable	getException() Returns the cause of the connection failure.
IoSession	getSession()
boolean	isConnected()
void	setException(Throwable exception) Sets the exception caught due to connection failure and notifies all threads waiting for this future.
void	setSession(IoSession session) Sets the newly connected session and notifies all threads waiting for this future.

Methods inherited from class org.apache.sshd.common.future.DefaultSshFuture

addListener, await0, cancel, getNumRegisteredListeners, getValue, isCanceled, isDone, notifyListeners, removeListener, setValue, toString

Methods inherited from class org.apache.sshd.common.future.AbstractSshFuture

asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, getId, notifyListener, verifyResult

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.io.IoConnectFuture

cancel, isCanceled

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

addListener, removeListener

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

await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone

Constructor Detail

DefaultIoConnectFuture

public DefaultIoConnectFuture(Object id,
                              Object lock)

Method Detail

getSession

public IoSession getSession()

Specified by:

getSession in interface IoConnectFuture

Returns:

The current IoSession - may be null if connect operation not finished yet or attempt has failed

See Also:

IoConnectFuture.getException()

getException

public Throwable getException()

Description copied from interface: IoConnectFuture

Returns the cause of the connection failure.

Specified by:

getException in interface IoConnectFuture

Returns:

null if the connect operation is not finished yet, or if the connection attempt is successful.

See Also:

IoConnectFuture.getSession()

isConnected

public boolean isConnected()

Specified by:

isConnected in interface IoConnectFuture

Returns:

true if the connect operation is finished successfully.

setSession

public void setSession(IoSession session)

Description copied from interface: IoConnectFuture

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.

Specified by:

setSession in interface IoConnectFuture

Parameters:

session - The connected IoSession

setException

public void setException(Throwable exception)

Description copied from interface: IoConnectFuture

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.

Specified by:

setException in interface IoConnectFuture

Parameters:

exception - The caught Throwable