PeriodicTimer.WaitForNextTickAsync(CancellationToken) Metodo
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Attende il segno di spunta successivo del timer o il timer deve essere arrestato.
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)Parametri
- cancellationToken
- CancellationToken
Oggetto CancellationToken per annullare l'attesa asincrona. Se viene richiesto l'annullamento, influisce solo sull'operazione di attesa singola; il timer sottostante continua l'attivazione.
Restituisce
Oggetto ValueTask<TResult> che verrà completato a causa dell'attivazione del timer, Dispose() chiamata per arrestare il timer o annullamento richiesto.
Eccezioni
Il token di annullamento è stato annullato. Questa eccezione viene archiviata nell'attività restituita.
Commenti
Il risultato dell'oggetto restituito ValueTask<TResult> è true quando viene completato a causa dell'attivazione del timer e false quando il timer viene eliminato. L'oggetto restituito ValueTask<TResult> passa allo stato Canceled quando viene richiesto l'annullamento. Se l'oggetto CancellationToken è già stato annullato quando WaitForNextTickAsync(CancellationToken) è stato chiamato, l'oggetto restituito ValueTask<TResult> viene creato nello stato Canceled.
Si PeriodicTimer comporta come un evento di reimpostazione automatica, in quanto più tick vengono uniti in un singolo segno di graduazione se si verificano tra le chiamate a WaitForNextTickAsync(CancellationToken). Analogamente, una chiamata a Dispose() annulla qualsiasi graduazione non ancora utilizzata. WaitForNextTickAsync(CancellationToken) può essere usato solo da un consumer alla volta e può essere usato simultaneamente con una singola chiamata a Dispose().
