PeriodicTimer.WaitForNextTickAsync(CancellationToken) Metodo

Definizione

Spazio dei nomi:

System.Threading

Assembly:

System.Runtime.dll

Origine:

PeriodicTimer.cs

Attende che il segno di spunta successivo del timer o che il timer venga 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 a sparare.

Restituisce

ValueTask<Boolean>

Attività che verrà completata a causa dell'attivazione del timer, Dispose() chiamata per arrestare il timer o annullare la richiesta.

Eccezioni

OperationCanceledException

Il token di annullamento è stato annullato. Questa eccezione viene archiviata nell'attività restituita.

Commenti

Il PeriodicTimer comportamento si comporta come un evento di reimpostazione automatica, in che più tick vengono uniti in un singolo segno di spunta se si verificano tra le chiamate a WaitForNextTickAsync(CancellationToken). Analogamente, una chiamata a Dispose() nullerà qualsiasi segno di spunta non ancora utilizzato. WaitForNextTickAsync(CancellationToken) può essere usato solo da un consumer alla volta e può essere usato simultaneamente con una singola chiamata a Dispose().