Freigeben über


PeriodicTimer.WaitForNextTickAsync(CancellationToken) Methode

Definition

Wartet auf den nächsten Tick 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

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

Gibt zurück

Ein ValueTask<TResult> Vorgang, der aufgrund des Auslösens des Zeitgebers abgeschlossen wird, der aufgerufen wird, Dispose() um den Timer zu beenden, oder der Abbruch wird angefordert.

Ausnahmen

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

Hinweise

Das Ergebnis des zurückgegebenen ValueTask<TResult> Vorgangs ist true der Zeitpunkt, an dem er aufgrund des Auslösens des Zeitgebers abgeschlossen ist und false der Timer verworfen wird. Der zurückgegebene ValueTask<TResult> Wert gibt den Status "Abgebrochen" ein, wenn der Abbruch angefordert wird. Wenn der CancellationToken Aufruf bereits abgebrochen WaitForNextTickAsync(CancellationToken) wurde, wird der zurückgegebene ValueTask<TResult> Wert im Status "Abgebrochen" erstellt.

Das PeriodicTimer Verhalten verhält sich wie ein Automatisches Zurücksetzen-Ereignis, in dem mehrere Teilstriche in einem einzigen Teilstrich zusammengeführt werden, wenn sie zwischen Aufrufen WaitForNextTickAsync(CancellationToken)auftreten. Auf ähnliche Weise wird ein Aufruf, um Dispose() einen Tick nicht zu leeren, der noch nicht verbraucht wurde. WaitForNextTickAsync(CancellationToken) kann nur jeweils von einem Verbraucher verwendet werden und kann gleichzeitig mit einem einzigen Aufruf Dispose()verwendet werden.

Gilt für: