PeriodicTimer.WaitForNextTickAsync(CancellationToken) Metoda

Definice

Obor názvů:

System.Threading

Sestavení:

System.Runtime.dll

Zdroj:

PeriodicTimer.cs

Čeká na další zaškrtnutí časovače nebo na zastavení časovače.

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)

Parametry

cancellationToken

CancellationToken

A CancellationToken pro zrušení asynchronního čekání. Pokud je požadováno zrušení, má vliv pouze na jednu operaci čekání; základní časovač pokračuje ve aktivaci.

Návraty

ValueTask<Boolean>

Úkol, který bude dokončen kvůli aktivaci časovače, Dispose() zavolání kvůli zastavení časovače nebo kvůli požadavku na zrušení.

Výjimky

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.

Poznámky

Chová PeriodicTimer se jako událost automatického resetování v tom, že více zaškrtnutí je sloučeno do jediného zaškrtnutí, pokud k nim dojde mezi voláními WaitForNextTickAsync(CancellationToken). Podobně volání Dispose() zruší všechna zaškrtnutí, která ještě nebyla spotřebována. WaitForNextTickAsync(CancellationToken)může být současně používán pouze jedním příjemcem a může být použit současně s jedním voláním .Dispose()