org.apache.sshd.common.future

Interface SshFuture<T extends SshFuture>

Type Parameters:

T - Type of future

All Superinterfaces:

WaitableFuture

All Known Subinterfaces:

AuthFuture, CloseFuture, ConnectFuture, IoConnectFuture, IoReadFuture, IoWriteFuture, KeyExchangeFuture, OpenFuture

All Known Implementing Classes:

AbstractIoWriteFuture, AbstractSshFuture, ChannelAsyncInputStream.IoReadFutureImpl, DefaultAuthFuture, DefaultCloseFuture, DefaultConnectFuture, DefaultKeyExchangeFuture, DefaultOpenFuture, DefaultSshFuture, DefaultVerifiableSshFuture, IoWriteFutureImpl, MinaSession.Future, Nio2Connector.DefaultIoConnectFuture, Nio2DefaultIoWriteFuture, PendingWriteFuture

public interface SshFuture<T extends SshFuture>
extends WaitableFuture

Represents the completion of an asynchronous SSH operation on a given object (it may be an SSH session or an SSH channel). Can be listened for completion using a SshFutureListener.

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
T	addListener(SshFutureListener<T> listener) Adds an event listener which is notified when this future is completed.
T	removeListener(SshFutureListener<T> listener) Removes an existing event listener so it won't be notified when the future is completed.

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

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

Method Detail

addListener

T addListener(SshFutureListener<T> listener)

Adds an event listener which is notified when this future is completed. If the listener is added after the completion, the listener is directly notified.

Parameters:

listener - The SshFutureListener instance to add

Returns:

The future instance

removeListener

T removeListener(SshFutureListener<T> listener)

Removes an existing event listener so it won't be notified when the future is completed.

Parameters:

listener - The SshFutureListener instance to remove

Returns:

The future instance