Interface ConnectFuture

All Superinterfaces:
ClientSessionHolder, SessionContextHolder, SessionHolder<ClientSession>, SshFuture<ConnectFuture>, VerifiableFuture<ConnectFuture>, WaitableFuture
All Known Implementing Classes:
DefaultConnectFuture

An SshFuture for asynchronous connections requests.
  • 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.
    • isCanceled

      boolean isCanceled()
      Returns:
      true if the connect operation has been canceled by cancel() method.
    • 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
    • getException

      Throwable getException()
      Returns the cause of the connection failure.
      Returns:
      null if the connect operation is not finished yet, or if the connection attempt is successful (use WaitableFuture.isDone() to distinguish between the two)
    • setException

      void setException(Throwable exception)
      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.
      Parameters:
      exception - The caught Throwable
    • cancel

      void cancel()
      Cancels the connection attempt and notifies all threads waiting for this future.