PeriodicTimer.WaitForNextTickAsync(CancellationToken) 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
等待计时器的下一刻度,或等待计时器停止。
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
用于取消异步等待的 A CancellationToken 。 如果请求取消,则仅影响单个等待操作;基础计时器继续触发。
返回
ValueTask<TResult>由于计时器触发、Dispose()调用以停止计时器或请求取消,将完成该触发器。
例外
取消令牌已取消。 此异常存储在返回的任务中。
注解
返回 ValueTask<TResult> 的结果是 true 由于计时器触发而完成,以及 false 释放计时器的时间。 当请求取消时,返回 ValueTask<TResult> 的返回将进入“取消”状态。
CancellationToken如果在调用时WaitForNextTickAsync(CancellationToken)已取消,则返回ValueTask<TResult>的创建状态为“已取消”。
行为 PeriodicTimer 类似于自动重置事件,因此,如果多个时钟周期在调用 WaitForNextTickAsync(CancellationToken)之间发生,则它们合并为单个时钟周期。 同样,调用 Dispose() 将取消尚未使用的任何时钟周期。 WaitForNextTickAsync(CancellationToken) 一次只能由一个使用者使用,并且可以同时与单个调用 Dispose()一起使用。