Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

OperationCanceledException — sygnalizowanie anulowania operacji

OperationCanceledException sygnalizuje anulowanie operacji. Poznaj współpracę z CancellationToken, znaczenie ThrowIfCancellationRequested() i różnicę między żądaniem anulowania a jego obsłużeniem.

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

Składnia

token.ThrowIfCancellationRequested();
throw new OperationCanceledException(token);
catch (OperationCanceledException ex) when (ex.CancellationToken == token && token.IsCancellationRequested) { /* handle expected cancellation */ }

OperationCanceledException z przestrzeni nazw System służy do zgłaszania anulowania operacji. Anulowanie jest kooperacyjne: CancellationTokenSource.Cancel() zgłasza żądanie, ale samo nie przerywa wykonywanego kodu. Operacja musi je zauważyć i zakończyć pracę.

Preferowany punkt kontroli to token.ThrowIfCancellationRequested(): rzuca wyjątek tylko wtedy, gdy zażądano anulowania, i dołącza token. Odpowiada to sprawdzeniu token.IsCancellationRequested i wykonaniu throw new OperationCanceledException(token);. Właściwość wyjątku CancellationToken pozwala ustalić, z którym tokenem jest związany.

TaskCanceledException dziedziczy po OperationCanceledException, więc przechwycenie klasy bazowej obejmuje oba typy. Obsługuj oczekiwane anulowanie na odpowiedniej granicy operacji; filtr w przykładzie sprawdza zarówno tożsamość tokena, jak i żądanie anulowania, zamiast ignorować każdy taki wyjątek.

W przeciążeniach Task.Run(..., token) przeznaczonych dla delegatów synchronicznych, jeśli delegat zostanie uruchomiony i zgłosi ten wyjątek, zadanie przejdzie w stan Canceled tylko wtedy, gdy token wyjątku jest zgodny z przekazanym tokenem i zażądano anulowania za jego pośrednictwem. W przeciwnym razie zadanie przejdzie w stan Faulted. Zwykły powrót z delegata oznacza RanToCompletion.

W przypadku delegata async, który zwraca zadanie, nieprzechwycony OperationCanceledException może anulować zadanie wewnętrzne nawet wtedy, gdy token wyjątku różni się od tokena przekazanego do Task.Run lub gdy nie zażądano anulowania. Zadanie pośredniczące zwrócone przez Task.Run odzwierciedla sposób zakończenia zadania wewnętrznego. Przykład synchroniczny pokazuje mechanizm bez wyścigów czasowych i nie wymaga funkcji języka w wersji preview.

Przykłady

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");
}

Wynik

Canceled

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła