PeriodicTimer.WaitForNextTickAsync(CancellationToken) Methode

Definition

Namespace:

System.Threading

Assembly:

System.Runtime.dll

Quelle:

PeriodicTimer.cs

Wartet auf das nächste Ticken des Timers oder auf das Beenden des Timers.

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)

Parameter

cancellationToken

CancellationToken

Ein CancellationToken zum Abbrechen der asynchronen Wartezeit. Wenn ein Abbruch angefordert wird, wirkt sich dies nur auf den einzelnen Wartevorgang aus. der zugrunde liegende Timer wird weiterhin ausgelöst.

Gibt zurück

ValueTask<Boolean>

Eine Aufgabe, die aufgrund des Auslösens des Timers, Dispose() des Aufrufs zum Beenden des Timers oder des angeforderten Abbruchs abgeschlossen wird.

Ausnahmen

OperationCanceledException

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Hinweise

Verhält PeriodicTimer sich wie ein Ereignis für automatisches Zurücksetzen, da mehrere Ticks zu einem einzelnen Tick zusammengefasst werden, wenn sie zwischen Aufrufen von WaitForNextTickAsync(CancellationToken)auftreten. Ebenso wird ein Aufruf von Dispose() alle noch nicht verbrauchten Ticks ungültig. WaitForNextTickAsync(CancellationToken) kann jeweils nur von einem Consumer verwendet werden und kann gleichzeitig mit einem einzelnen Aufruf Dispose()von verwendet werden.