Package org.apache.sshd.client.future
Interface OpenFuture
-
- All Superinterfaces:
SshFuture<OpenFuture>
,VerifiableFuture<OpenFuture>
,WaitableFuture
- All Known Implementing Classes:
DefaultOpenFuture
public interface OpenFuture extends SshFuture<OpenFuture>, VerifiableFuture<OpenFuture>
AnSshFuture
for asynchronous channel opening requests.- Author:
- Apache MINA SSHD Project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
cancel()
Cancels the connection attempt and notifies all threads waiting for this future.Throwable
getException()
Returns the cause of the connection failure.boolean
isCanceled()
boolean
isOpened()
void
setException(Throwable exception)
Sets the exception caught due to connection failure and notifies all threads waiting for this future.void
setOpened()
Sets the newly connected session and notifies all threads waiting for this future.-
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 Detail
-
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).
-
isOpened
boolean isOpened()
- Returns:
true
if the connect operation is finished successfully.
-
isCanceled
boolean isCanceled()
- Returns:
true
if the connect operation has been canceled bycancel()
method.
-
setOpened
void setOpened()
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.
-
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 caughtThrowable
-
cancel
void cancel()
Cancels the connection attempt and notifies all threads waiting for this future.
-
-