Language

CA2027: Task.WhenAny の完了後に Task.Delay を取り消す

プロパティ Value
ルール ID CA2027
肩書き Task.Delayの完了後にTask.WhenAnyを取り消す
カテゴリ 信頼性
修正が破壊的変更か非破壊的変更か Non-breaking
.NET 10 で既定で有効 No
.NET 11 で既定で有効 一つの提案として
該当する言語 C# と Visual Basic

Cause

WhenAny への呼び出しには、Delay を受け入れない CancellationToken 呼び出しが含まれます。

ルールの説明

別のタスクが最初に完了すると、タイムアウトの有効期限が切れるまで、キャンセルできない遅延が引き続き実行されます。 未使用のタイマーはリソースを消費します。

違反を修正する方法

タイムアウト付きで操作を待機するだけで済む場合は、Task.WaitAsync(TimeSpan)を使用します。 タイムアウト前に操作が完了しない場合は、 TimeoutException がスローされます。

Task.WhenAnyを呼び出す必要がある場合は、Task.Delay にキャンセル トークンを渡し、他のタスクが完了したときにトークン ソースを取り消します。

例示

次のコードは、CA2027 の違反を示しています。

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

タイムアウトのみが必要な場合は、Task.WaitAsync を使用してください。

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

または、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

どのようなときに警告を抑制するか

別のタスクの完了後に遅延を続行する必要がある場合にのみ、警告を抑制します。

警告を抑制する

1 つの違反を抑制するには、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、ルールを再度有効にします。

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

ファイル、フォルダー、またはプロジェクトのルールを無効にするには、noneでその重要度をに設定します。

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

詳細については、「 コード分析の警告を抑制する方法」を参照してください。

参照