Interface SshFuture<T extends SshFuture<T>>
- Type Parameters:
T- Type of future
- All Superinterfaces:
WaitableFuture
- All Known Subinterfaces:
AuthFuture, CancelFuture, CloseFuture, ConnectFuture, IoConnectFuture, IoReadFuture, IoWriteFuture, KeyExchangeFuture, OpenFuture
- All Known Implementing Classes:
AbstractIoWriteFuture, AbstractSshFuture, ChannelAsyncInputStream.IoReadFutureImpl, ChannelAsyncOutputStream.BufferedFuture, DefaultAuthFuture, DefaultCancelFuture, DefaultCancellableSshFuture, DefaultCloseFuture, DefaultConnectFuture, DefaultIoConnectFuture, DefaultKeyExchangeFuture, DefaultOpenFuture, DefaultSshFuture, DefaultVerifiableSshFuture, GlobalRequestFuture, IoWriteFutureImpl, Nio2DefaultIoWriteFuture, PendingWriteFuture, SimpleIoOutputStream.DefaultIoWriteFuture
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.-
Method Summary
Modifier and TypeMethodDescriptionaddListener(SshFutureListener<T> listener) Adds an event listener which is notified when this future is completed.removeListener(SshFutureListener<T> listener) Removes an existing event listener so it won't be notified when the future is completed.Methods inherited from interface WaitableFuture
await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone
-
Method Details
-
addListener
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- TheSshFutureListenerinstance to add- Returns:
- The future instance
-
removeListener
Removes an existing event listener so it won't be notified when the future is completed.- Parameters:
listener- TheSshFutureListenerinstance to remove- Returns:
- The future instance
-