PeriodicTimer.WaitForNextTickAsync(CancellationToken) Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Ожидает следующего деления таймера или остановки таймера.
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 для отмены асинхронного ожидания. Если запрашивается отмена, это влияет только на одну операцию ожидания; базовый таймер продолжает работу.
Возвращаемое значение
Задача, которая будет завершена из-за срабатывания таймера, Dispose() вызова для остановки таймера или запроса отмены.
Исключения
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Комментарии
выполняется PeriodicTimer как событие автоматического сброса, так как несколько тактов объединяются в один такт, если они происходят между вызовами WaitForNextTickAsync(CancellationToken). Аналогичным образом, вызов приведет к аннулированию Dispose() всех тактов, которые еще не были использованы. WaitForNextTickAsync(CancellationToken) может использоваться только одним потребителем одновременно и может использоваться одновременно с одним вызовом Dispose().