GrainCancellationTokenSource.Cancel Method

Definition

Communicates a request for cancellation.

public System.Threading.Tasks.Task Cancel ();
member this.Cancel : unit -> System.Threading.Tasks.Task
Public Function Cancel () As Task

Returns

Exceptions

An aggregate exception containing all the exceptions thrown by the registered callbacks on the associated GrainCancellationToken .

Remarks

The associated GrainCancellationToken will be notified of the cancellation and will transition to a state where CancellationToken returns true. Any callbacks or cancelable operations registered with the CancellationToken will be executed.

Cancelable operations and callbacks registered with the token should not throw exceptions. However, this overload of Cancel() will aggregate any exceptions thrown into a 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.

Applies to