PeriodicTimer.WaitForNextTickAsync(CancellationToken) Metoda
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Č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í, ovlivňuje pouze jednu operaci čekání; základní časovač pokračuje ve spuštění.
Návraty
To ValueTask<TResult> bude dokončeno kvůli aktivaci časovače, Dispose() který je volána k zastavení časovače nebo zrušení, které se požaduje.
Výjimky
Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.
Poznámky
Výsledek vráceného ValueTask<TResult>true je, když je dokončený kvůli aktivaci časovače a false kdy je časovač uvolněn.
ValueTask<TResult> Vrácený stav se při vyžádání zrušení zadá do stavu Zrušeno.
CancellationToken Pokud již byla zrušena při WaitForNextTickAsync(CancellationToken) zavolání, vrácená ValueTask<TResult> hodnota se vytvoří ve stavu Zrušeno.
Chová PeriodicTimer se jako událost automatického resetování v tom, že více záškrtů je sloučeno do jediného zaškrtnutí, pokud dojde mezi voláními WaitForNextTickAsync(CancellationToken). Podobně volání, které Dispose() bude vyprázdnit žádné záškrty ještě nespotřebované. WaitForNextTickAsync(CancellationToken) může být používán pouze jedním příjemcem najednou a může být používán souběžně s jedním voláním Dispose().
