TplExtensions.ToTask(WaitHandle, Int32, CancellationToken) Metoda
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Tworzy zadanie TPL zwracane, gdy WaitHandle element jest zasygnalizowany lub zwracafalse
, true
jeśli pierwszy limit czasu wystąpi.
public static System.Threading.Tasks.Task<bool> ToTask (this System.Threading.WaitHandle handle, int timeout = -1, System.Threading.CancellationToken cancellationToken = default);
static member ToTask : System.Threading.WaitHandle * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
<Extension()>
Public Function ToTask (handle As WaitHandle, Optional timeout As Integer = -1, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)
Parametry
- handle
- WaitHandle
Uchwyt, którego sygnał wyzwala zadanie do ukończenia. Nie należy używać elementu Mutex tutaj.
- timeout
- Int32
Limit czasu (w milisekundach), po którym zadanie zwróci, jeśli dojście nie zostanie false
zasygnalizowane przez ten czas.
- cancellationToken
- CancellationToken
Token, którego anulowanie spowoduje natychmiastowe zakończenie zwróconego zadania w stanie anulowanym.
Zwraca
Zadanie, które kończy się, gdy dojście jest sygnalizowane lub upłynął limit czasu lub gdy token anulowania elementu wywołującego zostanie anulowany.
Jeśli zadanie zakończy się, ponieważ uchwyt jest sygnalizowany, wynik zadania to true
.
Jeśli zadanie zakończy się, ponieważ uchwyt nie jest sygnalizowany przed przekroczeniem limitu czasu, wynik zadania to false
.
Uwagi
Ukończenie zwróconego zadania jest asynchroniczne w odniesieniu do kodu, który w rzeczywistości sygnalizuje uchwyt oczekiwania.