PeriodicTimer.WaitForNextTickAsync(CancellationToken) Método

Definição

Namespace:

System.Threading

Assembly:

System.Runtime.dll

Origem:

PeriodicTimer.cs

Aguarda o próximo tique do temporizador ou para que o temporizador seja interrompido.

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)

Parâmetros

cancellationToken

CancellationToken

Um CancellationToken para cancelar a espera assíncrona. Se o cancelamento for solicitado, ele afetará apenas a operação de espera única; o temporizador subjacente continua disparando.

Retornos

ValueTask<Boolean>

Uma tarefa que será concluída devido ao acionamento do temporizador, Dispose() ao ser chamado para interromper o temporizador ou ao cancelamento que está sendo solicitado.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

O PeriodicTimer se comporta como um evento de redefinição automática, pois vários tiques são unidos em um único tique se ocorrerem entre chamadas para WaitForNextTickAsync(CancellationToken). Da mesma forma, uma chamada para Dispose() anulará qualquer tique ainda não consumido. WaitForNextTickAsync(CancellationToken) só pode ser usado por um consumidor por vez e pode ser usado simultaneamente com uma única chamada para Dispose().