TplExtensions.ToTask(WaitHandle, Int32, CancellationToken) Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Crea una tarea TPL que devuelve true
cuando WaitHandle se señala o devuelve false
si se produce un tiempo de espera en primer lugar.
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
Identificador cuya señal desencadena la tarea que se va a completar. No use un Mutex aquí.
- timeout
- Int32
Tiempo de espera (en milisegundos) después del cual la tarea devolverá false
si el identificador no se señala en ese momento.
- cancellationToken
- CancellationToken
Token cuya cancelación hará que la tarea devuelta se complete inmediatamente en un estado cancelado.
Devoluciones
Tarea que se completa cuando se señala o agota el tiempo de espera del identificador, o cuando se cancela el token de cancelación del autor de la llamada.
Si la tarea se completa porque se señala el identificador, el resultado de la tarea es true
.
Si la tarea se completa porque el identificador no se señala antes del tiempo de espera, el resultado de la tarea es false
.
Comentarios
La finalización de la tarea devuelta es asincrónica con respecto al código que indica realmente el identificador de espera.