Skip to content

Explain semantics of multiple calls to CancellationTokenSource.Cancel #11105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Explain semantics of multiple calls to CancellationTokenSource.Cancel #11105

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a2b566
Explain semantics of multiple calls to `CancellationTokenSource.Cancel`
Smaug123 Mar 18, 2025
45f918e
'will be notified' -> 'is notified'
Smaug123 Mar 25, 2025
8094c7a
Consistently use the present tense
Smaug123 Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions xml/System.Threading/CancellationTokenSource.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,8 +383,10 @@
## Remarks
The associated <xref:System.Threading.CancellationToken> will be notified of the cancellation and will transition to a state where <xref:System.Threading.CancellationToken.IsCancellationRequested%2A> returns true.

Any callbacks or cancelable operations registered with the <xref:System.Threading.CancellationToken> will be executed.

Any callbacks or cancelable operations registered with the <xref:System.Threading.CancellationToken> will be executed, if they have not already been executed by a previous call to <xref:System.Threading.CancellationTokenSource.Cancel>. Subsequent calls to <xref:System.Threading.CancellationTokenSource.Cancel> will not execute the same callback again unless re-registered. (We recommend avoiding multiple calls to <xref:System.Threading.CancellationTokenSource.Cancel>, because the intent of such code is often unclear.)

Callbacks will be executed synchronously in LIFO order.

We recommend that cancelable operations and callbacks registered with <xref:System.Threading.CancellationToken> not throw exceptions.

This overload of Cancel will aggregate any exceptions thrown into an <xref:System.AggregateException>, such that one callback throwing an exception will not prevent other registered callbacks from being executed.
Expand Down Expand Up @@ -458,7 +460,9 @@
## Remarks
The associated <xref:System.Threading.CancellationToken> will be notified of the cancellation and will transition to a state where <xref:System.Threading.CancellationToken.IsCancellationRequested%2A> returns `true`.

Any callbacks or cancelable operations registered with the <xref:System.Threading.CancellationToken> will be executed. Callbacks will be executed synchronously in LIFO order.
Any callbacks or cancelable operations registered with the <xref:System.Threading.CancellationToken> will be executed, if they have not already been executed by a previous call to <xref:System.Threading.CancellationTokenSource.Cancel>. Subsequent calls to <xref:System.Threading.CancellationTokenSource.Cancel> will not execute the same callback again unless re-registered. (We recommend avoiding multiple calls to <xref:System.Threading.CancellationTokenSource.Cancel>, because the intent of such code is often unclear.)

Callbacks will be executed synchronously in LIFO order.

We recommend that cancelable operations and callbacks registered with <xref:System.Threading.CancellationToken> not throw exceptions.

Expand Down