TplExtensions.ToTask(WaitHandle, Int32, CancellationToken) Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Cria uma Tarefa TPL que retorna true
quando um WaitHandle é sinalizado ou retorna false
se um tempo limite ocorre primeiro.
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)
Parâmetros
- handle
- WaitHandle
O identificador cujo sinal dispara a tarefa a ser concluída. Não use um Mutex aqui.
- timeout
- Int32
O tempo limite (em milissegundos) após o qual a tarefa retornará false
se o identificador não for sinalizado por esse tempo.
- cancellationToken
- CancellationToken
Um token cujo cancelamento fará com que a Tarefa retornada seja concluída imediatamente em um estado cancelado.
Retornos
Uma Tarefa que é concluída quando o identificador é sinalizado ou atinge o tempo limite ou quando o token de cancelamento do chamador é cancelado.
Se a tarefa for concluída porque o identificador está sinalizado, o resultado da tarefa será true
.
Se a tarefa for concluída porque o identificador não é sinalizado antes do tempo limite, o resultado da tarefa é false
.
Comentários
A conclusão da tarefa retornada é assíncrona em relação ao código que realmente sinaliza o identificador de espera.