Apache Mina SSHD 2.15.0 · org.apache.sshd.common.future.CancelFuture

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.

Method Summary

Modifier and Type	Method and Description
public CancellationException	Returns: a `CancellationException` getBackTrace() Obtains an exception describing the stack trace of where the cancellation was initiated.
public boolean	Returns: `true` if the cancellation was done; `false` otherwise isCanceled() Tells whether the cancellation has been effected.
public void	setBackTrace(CancellationException `CancellationException` to set backTrace) Sets a `CancellationException` describing the stack trace of where the cancellation was initiated.
public void	setCanceled() Marks this `CancelFuture` as the cancellation having been effected.
public void	setCanceled(Throwable optional `Throwable`, if non-`null`, it'll be attached to the backtrace. error) Marks this `CancelFuture` as the cancellation having been effected.
public void	setNotCanceled() Completes this future with a value indicating that the cancellation was not done.

Inherited from org.apache.sshd.common.future.SshFuture:: addListener removeListener
Inherited from org.apache.sshd.common.future.VerifiableFuture:: verify verify verify verify verify verify verify verify

Method Detail

getBackTrace back to summary

getBackTrace	back to summary
public CancellationException getBackTrace() Obtains an exception describing the stack trace of where the cancellation was initiated. Returns:CancellationException a `CancellationException`

public CancellationException getBackTrace()

Obtains an exception describing the stack trace of where the cancellation was initiated.

Returns:CancellationException: a CancellationException

isCanceled back to summary

isCanceled	back to summary
public boolean isCanceled() Tells whether the cancellation has been effected. (`isDone()` `&& !isCanceled()`) means the cancellation was not effected. In that case check the original operation for a success or failure value. Returns:boolean `true` if the cancellation was done; `false` otherwise

public boolean isCanceled()

Tells whether the cancellation has been effected. (isDone() && !isCanceled()) means the cancellation was not effected. In that case check the original operation for a success or failure value.

Returns:boolean: true if the cancellation was done; false otherwise

setBackTrace back to summary

setBackTrace	back to summary
public void setBackTrace(CancellationException backTrace) Sets a `CancellationException` describing the stack trace of where the cancellation was initiated. Has no effect if a backtrace was already set, or the given backtrace is `null`. This is a framework-internal method. Parameters backTrace:CancellationException `CancellationException` to set

public void setBackTrace(CancellationException backTrace)

Sets a CancellationException describing the stack trace of where the cancellation was initiated. Has no effect if a backtrace was already set, or the given backtrace is null.

This is a framework-internal method.

Parameters

backTrace:CancellationException: CancellationException to set

setCanceled back to summary

setCanceled	back to summary
public void setCanceled() Marks this `CancelFuture` as the cancellation having been effected. This is a framework-internal method.

public void setCanceled()

Marks this CancelFuture as the cancellation having been effected.

This is a framework-internal method.

setCanceled back to summary

setCanceled	back to summary
public void setCanceled(Throwable error) Marks this `CancelFuture` as the cancellation having been effected. This is a framework-internal method. Parameters error:Throwable optional `Throwable`, if non-`null`, it'll be attached to the backtrace.

public void setCanceled(Throwable error)

Marks this CancelFuture as the cancellation having been effected.

This is a framework-internal method.

Parameters

error:Throwable: optional Throwable, if non-null, it'll be attached to the backtrace.

setNotCanceled	back to summary
public void setNotCanceled() Completes this future with a value indicating that the cancellation was not done.

public Interface CancelFuture

Method Summary

Method Detail