Package org.apache.sshd.client.future
Interface ConnectFuture
- All Superinterfaces:
Cancellable,ClientSessionHolder,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 TypeMethodDescriptiondefault ClientSessionbooleanvoidsetSession(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, isCanceledMethods inherited from interface org.apache.sshd.common.session.SessionHolder
getSession, getSessionContextMethods inherited from interface org.apache.sshd.common.future.SshFuture
addListener, removeListenerMethods inherited from interface org.apache.sshd.common.future.VerifiableFuture
verify, verify, verify, verifyMethods inherited from interface org.apache.sshd.common.future.WaitableFuture
await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDoneMethods inherited from interface org.apache.sshd.common.future.WithException
getException, setException
-
Method Details
-
getClientSession
- Specified by:
getClientSessionin interfaceClientSessionHolder- Returns:
- The underlying
ClientSessionused
-
isConnected
boolean isConnected()- Returns:
trueif the connect operation is finished successfully.
-
setSession
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- TheClientSession
-