Langue

CA2027 : Annuler Task.Delay une fois que Task.WhenAny est terminé

Propriété Value
ID de règle CA2027
Titre Annuler Task.Delay une fois l’opération Task.WhenAny terminée
Catégorie Fiabilité
Le correctif a un effet disruptif ou non disruptif Non-breaking
Activé par défaut dans .NET 10 No
Activé par défaut dans .NET 11 Comme suggestion
Langues applicables C# et Visual Basic

Cause

Un appel à WhenAny inclut un appel à Delay qui n’accepte pas de CancellationToken.

Description de la règle

Lorsqu’une autre tâche se termine en premier, un délai noncancelable continue de s’exécuter jusqu’à l’expiration de son délai d’expiration. Le minuteur inutilisé consomme des ressources.

Comment corriger les violations

Si vous n’avez besoin d’attendre qu’une opération avec un délai d’attente, utilisez Task.WaitAsync(TimeSpan). Elle lève une TimeoutException si l’opération ne se termine pas avant le délai d’expiration.

Si vous avez besoin d’appeler Task.WhenAny, transmettez un jeton d’annulation à Task.Delay la source du jeton et annulez la source du jeton une fois l’autre tâche terminée.

Examples

Le code suivant montre une violation de CA2027 :

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

Utilisez Task.WaitAsync quand vous n’avez besoin que d’un délai d’expiration :

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

Ou annulez le délai après le retour de Task.WhenAny :

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

Quand supprimer les avertissements

Masquez l’avertissement uniquement lorsque le délai doit se poursuivre après la fin d’une autre tâche.

Supprimer un avertissement

Pour supprimer une seule violation, ajoutez des directives de préprocesseur à votre fichier source pour désactiver, puis réactivez la règle.

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

Pour désactiver la règle sur un fichier, un dossier ou un projet, définissez sa gravité sur none dans le fichier de configuration.

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

Pour plus d’informations, consultez Comment supprimer les avertissements d’analyse du code.

Voir aussi