CKTIS / C#
OperationCanceledException – signalizace zrušení operace
OperationCanceledException signalizuje, že byla operace zrušena. Zjistěte, jak spolupracuje s CancellationToken, co dělá ThrowIfCancellationRequested() a jaký je rozdíl mezi požadavkem na zrušení a reakcí na něj.
Verze: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Syntaxe
token.ThrowIfCancellationRequested();
throw new OperationCanceledException(token);
catch (OperationCanceledException ex) when (ex.CancellationToken == token && token.IsCancellationRequested) { /* handle expected cancellation */ }OperationCanceledException v oboru názvů System signalizuje zrušení operace. Zrušení je kooperativní: CancellationTokenSource.Cancel() požádá o zrušení, ale samo nepřeruší právě prováděný kód. Operace musí požadavek zaznamenat a ukončit svou práci.
Doporučeným kontrolním bodem je token.ThrowIfCancellationRequested(): vyvolá výjimku pouze tehdy, když bylo požádáno o zrušení, a připojí token. Je to ekvivalent kontroly token.IsCancellationRequested a provedení throw new OperationCanceledException(token);. Vlastnost CancellationToken výjimky umožňuje určit token, se kterým je spojena.
TaskCanceledException dědí z OperationCanceledException, takže zachycení základní třídy pokrývá oba typy. Očekávané zrušení zpracujte na vhodné hranici operace; filtr v příkladu kontroluje identitu tokenu i požadavek na zrušení, místo aby ignoroval každou výjimku tohoto typu.
U přetížení Task.Run(..., token), která přijímají synchronního delegáta, přejde úloha po vyvolání této výjimky spuštěným delegátem do stavu Canceled pouze tehdy, když se token výjimky shoduje s předaným tokenem a prostřednictvím tohoto tokenu bylo požádáno o zrušení. Jinak úloha přejde do stavu Faulted. Běžný návrat z delegáta vede ke stavu RanToCompletion.
U delegáta async, který vrací úlohu, může výjimka OperationCanceledException nezachycená v delegátu zrušit vnitřní úlohu, i když se token výjimky liší od tokenu předaného metodě Task.Run nebo nebylo požádáno o zrušení. Zástupná úloha vrácená metodou Task.Run přebírá výsledek dokončení vnitřní úlohy. Synchronní příklad ukazuje mechanismus bez časových závodů a nevyžaduje jazykové funkce ve verzi preview.
Příklady
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");
}
Výsledek
Canceled
Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.