PeriodicTimer.WaitForNextTickAsync(CancellationToken) Metode

Definisi

Ruang nama:

System.Threading

Rakitan:

System.Runtime.dll

Sumber:

PeriodicTimer.cs

Menunggu kutu berikutnya dari timer, atau agar timer dihentikan.

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 untuk membatalkan penantian asinkron. Jika pembatalan diminta, itu hanya memengaruhi operasi tunggu tunggal; timer yang mendasar terus menembak.

Mengembalikan

ValueTask<Boolean>

Tugas yang akan diselesaikan karena pengalih waktu diaktifkan, Dispose() dipanggil untuk menghentikan timer, atau pembatalan diminta.

Pengecualian

OperationCanceledException

Token pembatalan dibatalkan. Pengecualian ini disimpan ke dalam tugas yang dikembalikan.

Keterangan

Berakibat PeriodicTimer seperti peristiwa reset otomatis, di mana beberapa tick digabungkan menjadi satu tanda centang jika terjadi di antara panggilan ke WaitForNextTickAsync(CancellationToken). Demikian pula, panggilan ke Dispose() akan membatalkan centang apa pun yang belum dikonsumsi. WaitForNextTickAsync(CancellationToken) hanya dapat digunakan oleh satu konsumen pada satu waktu, dan dapat digunakan bersamaan dengan satu panggilan ke Dispose().