net.lecousin.framework.concurrent.async

Interface Cancellable

All Known Subinterfaces:

IAsync<TError>

All Known Implementing Classes:

AbstractLock, Async, AsyncSupplier, JoinPoint, LockPoint, MutualExclusion, Task.Output, WaitingDataQueueSynchronizationPoint

public interface Cancellable

Interface for cancellable asynchronous task.

Method Summary

Modifier and Type	Method and Description
void	cancel(CancelException reason) Cancel this object: unblock it immediately, and set the cancellation reason.
CancelException	getCancelEvent() Get the reason of the cancellation.
boolean	isCancelled() Return true if this object is cancelled.

Method Detail

isCancelled

boolean isCancelled()

Return true if this object is cancelled.

cancel

void cancel(CancelException reason)

Cancel this object: unblock it immediately, and set the cancellation reason.

getCancelEvent

CancelException getCancelEvent()

Get the reason of the cancellation.