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

A CancellationToken для отмены асинхронного ожидания. При запросе отмены это влияет только на одну операцию ожидания; Базовый таймер продолжает выполнение.

Возвращаемое значение

ValueTask<Boolean>

Значение ValueTask<TResult> , которое будет завершено из-за запуска таймера, Dispose() вызываемого для остановки таймера или запрашиваемого отмены.

Исключения

OperationCanceledException

Маркер отмены был отменен. Это исключение хранится в возвращаемой задаче.

Комментарии

Результат возвращаемого ValueTask<TResult> значения заключается true в завершении из-за срабатывания таймера и false удаления таймера. Возвращаемое значение вводит состояние "Отменено ValueTask<TResult> " при запросе отмены. Если он CancellationToken уже был отменен при WaitForNextTickAsync(CancellationToken) вызове, возвращается ValueTask<TResult> в состоянии "Отменено".

Поведение PeriodicTimer , как событие автоматического сброса, в том, что несколько галок объединяются в один галок, если они происходят между вызовами WaitForNextTickAsync(CancellationToken). Аналогичным образом, вызов Dispose() будет пустовать какой-либо галок еще не используется. WaitForNextTickAsync(CancellationToken) может использоваться только одним потребителем одновременно и может использоваться одновременно с одним вызовом Dispose().