CKTIS / C#
OperationCanceledException: indicar la cancelación de una operación
OperationCanceledException indica que se ha cancelado una operación. Aprende cómo funciona con CancellationToken, qué hace ThrowIfCancellationRequested() y en qué se diferencian solicitar la cancelación y responder a ella.
Versión: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Sintaxis
token.ThrowIfCancellationRequested();
throw new OperationCanceledException(token);
catch (OperationCanceledException ex) when (ex.CancellationToken == token && token.IsCancellationRequested) { /* handle expected cancellation */ }OperationCanceledException, del espacio de nombres System, indica la cancelación de una operación. La cancelación es cooperativa: CancellationTokenSource.Cancel() solicita la cancelación, pero no interrumpe por sí mismo el código que se está ejecutando. La operación debe detectar la solicitud y detener su trabajo.
El punto de comprobación recomendado es token.ThrowIfCancellationRequested(): lanza una excepción solo si se ha solicitado la cancelación e incluye el token. Equivale a comprobar token.IsCancellationRequested y ejecutar throw new OperationCanceledException(token);. La propiedad CancellationToken de la excepción permite identificar el token asociado.
TaskCanceledException deriva de OperationCanceledException, por lo que capturar la clase base incluye ambos tipos. Gestiona la cancelación esperada en un límite adecuado de la operación; el filtro del ejemplo comprueba tanto la identidad del token como la solicitud de cancelación, en lugar de ignorar todas las excepciones de este tipo.
En las sobrecargas de Task.Run(..., token) que aceptan un delegado síncrono, si el delegado se ejecuta y lanza esta excepción, la tarea solo pasa al estado Canceled si el token de la excepción coincide con el token proporcionado y se ha solicitado la cancelación para ese token. De lo contrario, la tarea pasa a Faulted. Si el delegado termina con normalidad, el estado es RanToCompletion.
En un delegado async que devuelve una tarea, una OperationCanceledException que el delegado no capture puede cancelar la tarea interna aunque el token de la excepción sea distinto del proporcionado a Task.Run o no se haya solicitado la cancelación. La tarea proxy que devuelve Task.Run refleja cómo termina la tarea interna. El ejemplo síncrono muestra el mecanismo sin carreras temporales y no requiere características del lenguaje en versión preview.
Ejemplos
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");
}
Resultado
Canceled
El código mostrado y el resultado declarado se verificaron en un entorno aislado mediante el método registrado en la evidencia de verificación de esta versión exacta.