PeriodicTimer.WaitForNextTickAsync(CancellationToken) Método
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Espera pelo próximo tick do temporizador, ou pelo temporizador ser parado.
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
A CancellationToken por cancelar a espera assíncrona. Se for solicitado o cancelamento, afeta apenas a operação de espera única; O temporizador subjacente continua a disparar.
Devoluções
A que será concluída devido ao disparo do temporizador, Dispose() ao ser chamado para parar o temporizador, ou ao pedido de ValueTask<TResult> cancelamento.
Exceções
O token de cancelamento foi cancelado. Esta exceção é armazenada na tarefa devolvida.
Observações
O resultado do retorno ValueTask<TResult> é true quando é concluído devido ao disparo do temporizador, e false quando o temporizador é eliminado. O retornado ValueTask<TResult> entra no estado Cancelado quando é solicitado o cancelamento. Se o CancellationToken já estava cancelado quando WaitForNextTickAsync(CancellationToken) foi chamado, o retorno ValueTask<TResult> é criado no estado Cancelado.
Comporta-se PeriodicTimer como um evento de auto-reset, no sentido de que múltiplos ticks são coalescidos num único tick se ocorrerem entre chamadas para WaitForNextTickAsync(CancellationToken). De forma semelhante, um chamado para Dispose() anulará qualquer carrapato ainda não consumido. WaitForNextTickAsync(CancellationToken) pode ser usado apenas por um consumidor de cada vez, e pode ser usado em simultâneo com uma única chamada para Dispose().
