Package org.apache.sshd.client.future
Interface ConnectFuture
- All Superinterfaces:
ClientSessionHolder
,SessionContextHolder
,SessionHolder<ClientSession>
,SshFuture<ConnectFuture>
,VerifiableFuture<ConnectFuture>
,WaitableFuture
- All Known Implementing Classes:
DefaultConnectFuture
public interface ConnectFuture
extends SshFuture<ConnectFuture>, VerifiableFuture<ConnectFuture>, SessionHolder<ClientSession>, ClientSessionHolder
An
SshFuture
for asynchronous connections requests.-
Method Summary
Modifier and TypeMethodDescriptionvoid
cancel()
Cancels the connection attempt and notifies all threads waiting for this future.default ClientSession
Returns the cause of the connection failure.boolean
boolean
void
setException
(Throwable exception) Sets the exception caught due to connection failure and notifies all threads waiting for this future.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.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
-
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.
-
isCanceled
boolean isCanceled()- Returns:
true
if the connect operation has been canceled bycancel()
method.
-
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
-
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 (useWaitableFuture.isDone()
to distinguish between the two)
-
setException
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 caughtThrowable
-
cancel
void cancel()Cancels the connection attempt and notifies all threads waiting for this future.
-