PeriodicTimer.WaitForNextTickAsync(CancellationToken) 方法

定义

命名空间:

System.Threading

程序集:

System.Runtime.dll

Source:

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()同时使用。