PeriodicTimer.WaitForNextTickAsync(CancellationToken) メソッド

定義

名前空間:

System.Threading

アセンブリ:

System.Runtime.dll

ソース:

PeriodicTimer.cs

タイマーの次のティック、またはタイマーが停止するまで待機します。

public System.Threading.Tasks.ValueTask<bool> WaitForNextTickAsync (System.Threading.CancellationToken cancellationToken = default);

member this.WaitForNextTickAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<bool>

Public Function WaitForNextTickAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Boolean)

パラメーター

cancellationToken

CancellationToken

CancellationToken非同期待機を取り消す 。 取り消しが要求された場合、1 回の待機操作にのみ影響します。基になるタイマーは引き続き発生します。

戻り値

ValueTask<Boolean>

タイマーの発生、タイマーを停止するために呼び出される、 Dispose() または要求されているキャンセルが原因で完了するタスク。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

は PeriodicTimer 自動リセット イベントのように動作します。複数のティックが への呼び出しの間に発生した場合、1 つのティックに WaitForNextTickAsync(CancellationToken)結合されます。 同様に、 の Dispose() 呼び出しでは、まだ使用されていないティックは無効になります。 WaitForNextTickAsync(CancellationToken) は一度に 1 つのコンシューマーでのみ使用でき、 への Dispose()1 回の呼び出しと同時に使用できます。