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 取消非同步等候的 。 如果要求取消，它只會影響單一等候作業;基礎計時器會繼續引發。

傳回

ValueTask<Boolean>

因計時器引發、 Dispose() 呼叫以停止計時器或要求取消而完成的工作。

例外狀況

OperationCanceledException

解除標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

PeriodicTimer的行為就像自動重設事件一樣，在這種情況下，如果呼叫 之間 WaitForNextTickAsync(CancellationToken) 發生多個刻度，就會將多個刻度聯合成單一刻度。 同樣地，呼叫 Dispose() 將會使尚未取用的任何刻度失效。 WaitForNextTickAsync(CancellationToken) 一次只能由一個取用者使用，而且可以同時搭配對 的單一呼叫 Dispose() 使用。