Lenguaje

CA2027: Cancelar Task.Delay después de que Task.WhenAny se complete

Property Value
ID de regla CA2027
Title Cancelar Task.Delay después de que Task.WhenAny se complete
Categoría Fiabilidad
La corrección implica ruptura o no ruptura Non-breaking
Habilitado de forma predeterminada en .NET 10 No
Habilitado de forma predeterminada en .NET 11 Como sugerencia
Idiomas aplicables C# y Visual Basic

Cause

Una llamada a WhenAny incluye una Delay llamada que no acepta un CancellationToken.

Descripción de la regla

Cuando se completa primero otra tarea, un retraso no cancelable continúa ejecutándose hasta que expire su tiempo de espera. El temporizador no utilizado consume recursos.

Cómo corregir infracciones

Si solo necesita esperar una operación con un tiempo de espera, use Task.WaitAsync(TimeSpan). Produce un TimeoutException si la operación no se completa antes del tiempo de espera.

Si necesita llamar Task.WhenAnya , pase un token de cancelación a Task.Delay y cancele el origen del token cuando se complete la otra tarea.

Examples

El código siguiente muestra una infracción de CA2027:

Task winner = await Task.WhenAny(operation, Task.Delay(timeout));
Dim winner = Await Task.WhenAny(operation, Task.Delay(timeout))

Use Task.WaitAsync cuando solo necesite un tiempo de espera:

await operation.WaitAsync(timeout);
Await operation.WaitAsync(timeout)

O cancele el retraso después de que Task.WhenAny devuelva:

using var cts = new CancellationTokenSource();
Task winner = await Task.WhenAny(operation, Task.Delay(timeout, cts.Token));
cts.Cancel();
Using cts As New CancellationTokenSource()
    Dim winner = Await Task.WhenAny(operation, Task.Delay(timeout, cts.Token))
    cts.Cancel()
End Using

Cuándo suprimir las advertencias

Suprima la advertencia solo cuando el retraso debe continuar después de que se complete otra tarea.

Supresión de una advertencia

Para suprimir una sola infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y, a continuación, volver a habilitar la regla.

#pragma warning disable CA2027
// The code that's violating the rule is on this line.
#pragma warning restore CA2027

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad a none en el archivo de configuración.

[*.{cs,vb}]
dotnet_diagnostic.CA2027.severity = none

Para obtener más información, consulte Cómo suprimir advertencias de análisis de código.

Consulte también