WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / C#

CancellationTokenSource — Abbruch anfordern und Ressourcen freigeben

CancellationTokenSource verwaltet kooperativen Abbruch über ein CancellationToken. Cancel fordert dazu auf, die Arbeit zu beenden; Dispose gibt Ressourcen frei und bricht Vorgänge nicht ab.

Version: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Syntax

using var source = new CancellationTokenSource();
CancellationToken token = source.Token;
source.Cancel();
// source.Dispose() is called automatically at the end of the scope.

System.Threading.CancellationTokenSource stellt über Token ein Token bereit, das an Vorgänge weitergegeben wird. Cancel() setzt IsCancellationRequested in jeder Kopie dieses Tokens auf true. Abbruch erfolgt kooperativ: Der Code, der das Token empfängt, muss darauf reagieren; die Anforderung beendet einen Thread nicht zwangsweise. Mit CancelAfter(...) lässt sich eine Anforderung nach einer festgelegten Verzögerung planen.

CancellationTokenSource.Dispose() gibt Ressourcen frei, fordert aber keinen Abbruch an und ersetzt nicht das Warten darauf, dass die Arbeit beendet ist. Der Besitzer der Quelle sollte sie nach ihrer Verwendung freigeben, zum Beispiel mit using. Verwende die Quelle danach nicht weiter. Rufe Dispose() erst auf, wenn alle anderen Vorgänge für diese Quelle abgeschlossen sind; der Aufruf darf nicht gleichzeitig mit ihnen erfolgen.

Das net10.0-Beispiel liest zuerst den Zustand des Tokens aus, ruft dann Cancel() auf und liest den Zustand erneut aus. Beim Verlassen des using-Blocks wird vor der abschließenden Meldung Dispose() aufgerufen. Da keine Timer oder Hintergrundaufgaben verwendet werden, ist die Ausgabereihenfolge deterministisch.

Beispiele

using System;
using System.Threading;

using (var source = new CancellationTokenSource())
{
    CancellationToken token = source.Token;
    Console.WriteLine($"Before: {token.IsCancellationRequested}");

    source.Cancel();

    Console.WriteLine($"After: {token.IsCancellationRequested}");
}

Console.WriteLine("Source disposed.");

Ergebnis

Before: False
After: True
Source disposed.

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen