Este artículo se tradujo automáticamente. Para ver el artículo en inglés, active la casilla Inglés. Además, puede mostrar el texto en inglés en una ventana emergente si mueve el puntero del mouse sobre el texto.
Traducción
Inglés

Método ThreadPool.RegisterWaitForSingleObject (WaitHandle, WaitOrTimerCallback, Object, UInt32, Boolean)

 

Publicado: octubre de 2016

Registra un delegado para que espere a la clase WaitHandle y especifica un entero de 32 bits sin signo como tiempo de espera, en milisegundos.

Esta API no es conforme a CLS.

Espacio de nombres:   System.Threading
Ensamblado:  mscorlib (en mscorlib.dll)

[CLSCompliantAttribute(false)]
public static RegisteredWaitHandle RegisterWaitForSingleObject(
	WaitHandle waitObject,
	WaitOrTimerCallback callBack,
	object state,
	uint millisecondsTimeOutInterval,
	bool executeOnlyOnce
)

Parámetros

waitObject
Type: System.Threading.WaitHandle

La clase WaitHandle que se va a registrar. Use un WaitHandle diferente de Mutex.

callBack
Type: System.Threading.WaitOrTimerCallback

Delegado de WaitOrTimerCallback al que se llamará cuando el parámetro waitObject esté marcado.

state
Type: System.Object

Objeto que se ha pasado al delegado.

millisecondsTimeOutInterval
Type: System.UInt32

Tiempo de espera en milisegundos. Si el valor del parámetro millisecondsTimeOutInterval es 0 (cero), la función comprueba el estado del objeto y regresa inmediatamente. Si millisecondsTimeOutInterval es -1, el intervalo de tiempo de espera de la función nunca transcurre.

executeOnlyOnce
Type: System.Boolean

Es true para indicar que el subproceso no esperará en el parámetro waitObject después de haber llamado al delegado; es false para indicar que el temporizador se restablecerá cada vez que se complete la operación de espera, hasta que se anule el registro de la espera.

Valor devuelto

Type: System.Threading.RegisteredWaitHandle

RegisteredWaitHandle que puede usarse para cancelar la operación de espera registrada.

Exception Condition
ArgumentOutOfRangeException

El millisecondsTimeOutInterval parámetro es menor que -1.

Cuando haya terminado con el RegisteredWaitHandle que devuelve este método, llame a su RegisteredWaitHandle.Unregister método para liberar las referencias al identificador de espera. Se recomienda que siempre llame a la RegisteredWaitHandle.Unregister (método), incluso si especifica true para executeOnlyOnce. Colección de elementos no utilizados resulta más eficaz si se llama a la RegisteredWaitHandle.Unregister método en lugar de según el finalizador del controlador de espera registrada.

El RegisterWaitForSingleObject método pone en cola el delegado especificado en el grupo de subprocesos. Un subproceso de trabajo ejecutará al delegado cuando se produce uno de los siguientes:

  • El objeto especificado está en el estado señalado.

  • Se agota el tiempo de espera.

El RegisterWaitForSingleObjectmétodo comprueba el estado actual del objeto especificado WaitHandle. Si el estado del objeto no está señalado, el método registra una operación de espera. Un subproceso del grupo de subprocesos realiza la operación de espera. Un subproceso de trabajo ejecuta el delegado cuando el estado del objeto pasa a ser señalado o transcurre el intervalo de tiempo de espera. Si el timeOutInterval parámetro no es 0 (cero) y la executeOnlyOnce parámetro es false, el temporizador se restablece cada vez que el evento está señalado o transcurre el intervalo de tiempo de espera.

System_CAPS_importantImportante

Mediante un Mutex para waitObject no proporciona la exclusión mutua de devoluciones de llamada porque la API de Win32 subyacente utiliza el valor predeterminado WT_EXECUTEDEFAULT marca, por lo que cada devolución de llamada se envía en un subproceso independiente del grupo. En lugar de un Mutex, use un Semaphore con un recuento máximo de 1.

Para cancelar la operación de espera, llame a la RegisteredWaitHandle.Unregister (método).

El subproceso de espera utiliza Win32 WaitForMultipleObjects función para supervisar las operaciones de espera registrada. Por lo tanto, si debe utilizar el mismo identificador de sistema operativo nativo en varias llamadas a RegisterWaitForSingleObject, debe duplicar el identificador utilizando Win32 DuplicateHandle (función). Tenga en cuenta que no debe marcar un objeto de evento pasado a RegisterWaitForSingleObject, porque el subproceso de espera podría no detectar que el evento está señalado antes de restablecerse.

La función modifica el estado de algunos tipos de objetos de sincronización antes de devolverse. Modificación se produce sólo para el objeto cuyo estado señalado debe cumplirse la condición de espera. Por ejemplo, el recuento de un semáforo disminuye en uno.

A partir de .NET Framework versión 2.0, la Thread.CurrentPrincipal valor de propiedad se propaga a los subprocesos de trabajo en una cola mediante el RegisterWaitForSingleObject método. En versiones anteriores, no se propaga la información de entidad de seguridad.

En el ejemplo siguiente se muestra cómo utilizar el RegisterWaitForSingleObject método para ejecutar un método de devolución de llamada especificado cuando se señala un identificador de espera especificado. En este ejemplo, el método de devolución de llamada es WaitProc, y el identificador de espera es un AutoResetEvent.

El ejemplo define un TaskInfo clase para contener la información que se pasa a la devolución de llamada cuando se ejecuta. El ejemplo se crea un TaskInfo de objetos y asigna algunos datos de cadena. La RegisteredWaitHandle devuelta por la RegisterWaitForSingleObject método se asigna a la Handle campo de la TaskInfo objeto para que el método de devolución de llamada tiene acceso a la RegisteredWaitHandle.

Además de especificar TaskInfo como el objeto que se pasa al método de devolución de llamada, la llamada a la RegisterWaitForSingleObject método especifica el AutoResetEvent que esperará la tarea, un WaitOrTimerCallback delegado que representa el WaitProc método de devolución de llamada, un intervalo de tiempo de espera un segundo y varias devoluciones de llamada.

Cuando el subproceso principal señala el AutoResetEvent llamando a su Set (método), el WaitOrTimerCallback se invoca el delegado. El WaitProc método pruebas RegisteredWaitHandle para determinar si se ha producido un tiempo de espera. Si la devolución de llamada se invocó porque se señaló el identificador de espera, el WaitProc método anula el registro del RegisteredWaitHandle, deteniendo las devoluciones de llamada adicionales. En el caso de un tiempo de espera, la tarea sigue esperando. El WaitProc método se termina con la impresión de un mensaje en la consola.

using System;
using System.Threading;

// TaskInfo contains data that will be passed to the callback
// method.
public class TaskInfo {
    public RegisteredWaitHandle Handle = null;
    public string OtherInfo = "default";
}

public class Example {
    public static void Main(string[] args) {
        // The main thread uses AutoResetEvent to signal the
        // registered wait handle, which executes the callback
        // method.
        AutoResetEvent ev = new AutoResetEvent(false);

        TaskInfo ti = new TaskInfo();
        ti.OtherInfo = "First task";
        // The TaskInfo for the task includes the registered wait
        // handle returned by RegisterWaitForSingleObject.  This
        // allows the wait to be terminated when the object has
        // been signaled once (see WaitProc).
        ti.Handle = ThreadPool.RegisterWaitForSingleObject(
            ev,
            new WaitOrTimerCallback(WaitProc),
            ti,
            1000,
            false
        );

        // The main thread waits three seconds, to demonstrate the
        // time-outs on the queued thread, and then signals.
        Thread.Sleep(3100);
        Console.WriteLine("Main thread signals.");
        ev.Set();

        // The main thread sleeps, which should give the callback
        // method time to execute.  If you comment out this line, the
        // program usually ends before the ThreadPool thread can execute.
        Thread.Sleep(1000);
        // If you start a thread yourself, you can wait for it to end
        // by calling Thread.Join.  This option is not available with 
        // thread pool threads.
    }

    // The callback method executes when the registered wait times out,
    // or when the WaitHandle (in this case AutoResetEvent) is signaled.
    // WaitProc unregisters the WaitHandle the first time the event is 
    // signaled.
    public static void WaitProc(object state, bool timedOut) {
        // The state object must be cast to the correct type, because the
        // signature of the WaitOrTimerCallback delegate specifies type
        // Object.
        TaskInfo ti = (TaskInfo) state;

        string cause = "TIMED OUT";
        if (!timedOut) {
            cause = "SIGNALED";
            // If the callback method executes because the WaitHandle is
            // signaled, stop future execution of the callback method
            // by unregistering the WaitHandle.
            if (ti.Handle != null)
                ti.Handle.Unregister(null);
        } 

        Console.WriteLine("WaitProc( {0} ) executes on thread {1}; cause = {2}.",
            ti.OtherInfo, 
            Thread.CurrentThread.GetHashCode().ToString(), 
            cause
        );
    }
}

.NET Framework
Disponible desde 1.1
Silverlight
Disponible desde 2.0
Windows Phone Silverlight
Disponible desde 7.0
Volver al principio
Mostrar: