ConnectFuture

All Superinterfaces:: Cancellable, ClientSessionHolder, HasException, SessionContextHolder, SessionHolder<ClientSession>, SshFuture<ConnectFuture>, VerifiableFuture<ConnectFuture>, WaitableFuture, WithException

All Known Implementing Classes:: DefaultConnectFuture

public interface ConnectFuture extends SshFuture<ConnectFuture>, VerifiableFuture<ConnectFuture>, SessionHolder<ClientSession>, ClientSessionHolder, Cancellable

An SshFuture for asynchronous connections requests.

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 Cancellable
cancel, getCancellation, isCanceled

Methods inherited from interface HasException
getException

Methods inherited from interface SessionHolder
getSession, getSessionContext

Methods inherited from interface SshFuture
addListener, removeListener

Methods inherited from interface VerifiableFuture
verify, verify, verify, verify, verify, verify, verify, verify

Methods inherited from interface WaitableFuture
await, await, await, await, await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone

Methods inherited from interface 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