PeriodicTimer.WaitForNextTickAsync(CancellationToken) Metoda

Definicja

Przestrzeń nazw:

System.Threading

Zestaw:

System.Runtime.dll

Źródło:

PeriodicTimer.cs

Czeka na następny znacznik czasomierza lub na zatrzymanie czasomierza.

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

Element do CancellationToken anulowania oczekiwania asynchronicznego. Jeśli żądanie anulowania ma wpływ tylko na pojedynczą operację oczekiwania; podstawowy czasomierz kontynuuje wypalanie.

Zwraca

ValueTask<Boolean>

Zadanie, które zostanie ukończone z powodu wypalania czasomierza, Dispose() wywoływanego w celu zatrzymania czasomierza lub żądania anulowania.

Wyjątki

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwróconym zadaniu.

Uwagi

Zachowuje PeriodicTimer się jak zdarzenie automatycznego resetowania, w tym, że wiele kleszczy są łączyne w jeden znacznik, jeśli wystąpią między wywołaniami do WaitForNextTickAsync(CancellationToken). Podobnie wywołanie wywołania Dispose() spowoduje unieważnienie żadnego kleszcza, który nie został jeszcze wykorzystany. WaitForNextTickAsync(CancellationToken) może być używany tylko przez jednego konsumenta w danym momencie i może być używany współbieżnie z jednym wywołaniem do Dispose().