Package org.apache.sshd.common.future

Interface SshFuture<T extends SshFuture<T>>

Type Parameters:
T - Type of future
All Superinterfaces:
WaitableFuture
All Known Subinterfaces:
CancelFuture, CloseFuture, IoConnectFuture, IoReadFuture, IoWriteFuture
All Known Implementing Classes:
AbstractIoWriteFuture, AbstractSshFuture, DefaultCancelFuture, DefaultCancellableSshFuture, DefaultCloseFuture, DefaultIoConnectFuture, DefaultSshFuture, DefaultVerifiableSshFuture
public interface SshFuture<T extends SshFuture<T>> 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 Details

    • 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