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.- Author:
- Apache MINA SSHD Project
-
Method Summary
Modifier and TypeMethodDescriptiondefault ClientSession
boolean
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.session.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
Methods inherited from interface org.apache.sshd.common.future.WaitableFuture
await, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, getId, isDone
Methods inherited from interface org.apache.sshd.common.future.WithException
getException, setException
-
Method Details
-
getClientSession
- Specified by:
getClientSession
in interfaceClientSessionHolder
- Returns:
- The underlying
ClientSession
used
-
isConnected
boolean isConnected()- Returns:
true
if 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
-