Package org.apache.sshd.common.future
Interface CancelFuture
- All Superinterfaces:
SshFuture<CancelFuture>
,VerifiableFuture<Boolean>
,WaitableFuture
- All Known Implementing Classes:
DefaultCancelFuture
Cancellations may not always be effective immediately. While a cancelled
Cancellable
future is considered
canceled immediately, it may take some time until the underlying asynchronous operation is really canceled. A
cancellation through Cancellable.cancel()
returns a CancelFuture
that can be used to wait for the
cancellation to have been effected.
A CancelFuture
is not cancellable itself.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionObtains an exception describing the stack trace of where the cancellation was initiated.boolean
Tells whether the cancellation has been effected.void
setBackTrace
(CancellationException backTrace) Sets aCancellationException
describing the stack trace of where the cancellation was initiated.void
Marks thisCancelFuture
as the cancellation having been effected.void
setCanceled
(Throwable error) Marks thisCancelFuture
as the cancellation having been effected.void
Completes this future with a value indicating that the cancellation was not done.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
-
getBackTrace
CancellationException getBackTrace()Obtains an exception describing the stack trace of where the cancellation was initiated.- Returns:
- a
CancellationException
-
isCanceled
boolean isCanceled()Tells whether the cancellation has been effected. (WaitableFuture.isDone()
&& !isCanceled()
) means the cancellation was not effected. In that case check the original operation for a success or failure value.- Returns:
true
if the cancellation was done;false
otherwise
-
setCanceled
void setCanceled()Marks thisCancelFuture
as the cancellation having been effected.This is a framework-internal method.
-
setCanceled
Marks thisCancelFuture
as the cancellation having been effected.This is a framework-internal method.
- Parameters:
error
- optionalThrowable
, if non-null
, it'll be attached to the backtrace.
-
setBackTrace
Sets aCancellationException
describing the stack trace of where the cancellation was initiated. Has no effect if a backtrace was already set, or the given backtrace isnull
.This is a framework-internal method.
- Parameters:
backTrace
-CancellationException
to set
-
setNotCanceled
void setNotCanceled()Completes this future with a value indicating that the cancellation was not done.
-