| CancelableCancel Method (Boolean) |
Communicates a request for cancellation, and specifies whether remaining callbacks and cancelable operations should be processed.
Namespace:
Akka.Actor
Assembly:
Akka (in Akka.dll) Version: 1.2.3.42 (1.2.3.42)
Syntax public void Cancel(
bool throwOnFirstException
)
abstract Cancel :
throwOnFirstException : bool -> unit
override Cancel :
throwOnFirstException : bool -> unit
Parameters
- throwOnFirstException
- Type: SystemBoolean
true if exceptions should immediately propagate; otherwise, false.
Implements
ICancelableCancel(Boolean)Exceptions Remarks
The associated cancelable will be notified of the cancellation and will transition to a state where
IsCancellationRequested returns
true.
Any callbacks or cancelable operations registered with the cancelable will be executed.
Cancelable operations and callbacks registered with the token should not throw exceptions.
If
throwOnFirstException is
true, an exception will immediately propagate out of
the call to Cancel, preventing the remaining callbacks and cancelable operations from being processed.
If
throwOnFirstException is
false, this overload will aggregate any exceptions
thrown into an
AggregateException, such that one callback throwing an exception will not
prevent other registered callbacks from being executed.
The
ExecutionContext that was captured when each callback was registered will be reestablished when the callback is invoked.
See Also