CKTIS / C#
OperationCanceledException — het annuleren van een bewerking aangeven
OperationCanceledException geeft aan dat een bewerking is geannuleerd. Lees hoe deze uitzondering samenwerkt met CancellationToken, wat ThrowIfCancellationRequested() doet en wat het verschil is tussen annulering aanvragen en erop reageren.
Versie: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Syntax
token.ThrowIfCancellationRequested();
throw new OperationCanceledException(token);
catch (OperationCanceledException ex) when (ex.CancellationToken == token && token.IsCancellationRequested) { /* handle expected cancellation */ }OperationCanceledException in de naamruimte System geeft aan dat een bewerking is geannuleerd. Annulering verloopt coöperatief: CancellationTokenSource.Cancel() vraagt annulering aan, maar onderbreekt niet zelf de code die wordt uitgevoerd. De bewerking moet het verzoek opmerken en het werk stoppen.
Het aanbevolen controlepunt is token.ThrowIfCancellationRequested(): deze methode werpt alleen een uitzondering als annulering is aangevraagd en voegt het token toe. Dit komt overeen met het controleren van token.IsCancellationRequested en het uitvoeren van throw new OperationCanceledException(token);. De eigenschap CancellationToken van de uitzondering geeft aan welk token erbij hoort.
TaskCanceledException is afgeleid van OperationCanceledException, dus het afvangen van de basisklasse omvat beide typen. Handel verwachte annulering af op een geschikte grens van de bewerking; het filter in het voorbeeld controleert zowel de identiteit van het token als het annuleringsverzoek, in plaats van elke uitzondering van dit type te negeren.
Bij overloads van Task.Run(..., token) die een synchrone delegate accepteren, krijgt de taak, als de delegate wordt uitgevoerd en deze uitzondering werpt, alleen de status Canceled als het token van de uitzondering overeenkomt met het meegegeven token en voor dat token annulering is aangevraagd. Anders krijgt de taak de status Faulted. Keert de delegate normaal terug, dan krijgt de taak de status RanToCompletion.
Bij een async-delegate die een taak retourneert, kan een OperationCanceledException die niet in de delegate wordt afgevangen de interne taak annuleren, ook als het token van de uitzondering afwijkt van het aan Task.Run meegegeven token of als geen annulering is aangevraagd. De proxytaak die Task.Run retourneert, weerspiegelt hoe de interne taak eindigt. Het synchrone voorbeeld laat het mechanisme zien zonder timing-races en vereist geen preview-taalfuncties.
Voorbeelden
using System;
using System.Threading;
using var source = new CancellationTokenSource();
CancellationToken token = source.Token;
source.Cancel();
try
{
token.ThrowIfCancellationRequested();
Console.WriteLine("Completed");
}
catch (OperationCanceledException ex)
when (ex.CancellationToken == token && token.IsCancellationRequested)
{
Console.WriteLine("Canceled");
}
Resultaat
Canceled
De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.