Interface ConnectFuture

All Superinterfaces:
org.apache.sshd.common.future.Cancellable, ClientSessionHolder, org.apache.sshd.common.future.HasException, org.apache.sshd.common.session.SessionContextHolder, SessionHolder<ClientSession>, org.apache.sshd.common.future.SshFuture<ConnectFuture>, org.apache.sshd.common.future.VerifiableFuture<ConnectFuture>, org.apache.sshd.common.future.WaitableFuture, org.apache.sshd.common.future.WithException
All Known Implementing Classes:
DefaultConnectFuture
public interface ConnectFuture extends org.apache.sshd.common.future.SshFuture<ConnectFuture>, org.apache.sshd.common.future.VerifiableFuture<ConnectFuture>, SessionHolder<ClientSession>, ClientSessionHolder, org.apache.sshd.common.future.Cancellable
An SshFuture for asynchronous connections requests.
Author:
Apache MINA SSHD Project

  • Method Summary

    Modifier and Type
    Method
    Description
    default ClientSession
    getClientSession()
     
    boolean
    isConnected()
     
    void
    setSession(ClientSession session)
    Sets the newly connected session and notifies all threads waiting for this future.

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

    cancel, getCancellation, isCanceled

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

    getException

    Methods inherited from interface SessionHolder

    getSession, getSessionContext

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

    addListener, removeListener

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

    verify, verify, verify, verify, verify, verify, verify, verify

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

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

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

    setException

  • Method Details

    • getClientSession

      default ClientSession getClientSession()
      Specified by:
      getClientSession in interface ClientSessionHolder
      Returns:
      The underlying ClientSession used

    • isConnected

      boolean isConnected()
      Returns:
      true if the connect operation is finished successfully.

    • 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