Exportar (0) Imprimir
Expandir todo
Este artículo se tradujo de forma manual. Mueva el puntero sobre las frases del artículo para ver el texto original.
Traducción
Original

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

Registra un delegado que va a esperar a una clase WaitHandle, especificando un entero de 32 bits sin signo para representar el tiempo de espera en milisegundos.

Esta API no es compatible con 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
Tipo: System.Threading.WaitHandle
WaitHandle que se va a registrar. Utilice un WaitHandle diferente de Mutex.
callBack
Tipo: System.Threading.WaitOrTimerCallback
Delegado de WaitOrTimerCallback al que se va a llamar cuando el parámetro waitObject esté señalado.
state
Tipo: System.Object
Objeto que se ha pasado al delegado.
millisecondsTimeOutInterval
Tipo: 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
Tipo: System.Boolean
Es true para indicar que el subproceso ya no va a esperar en el parámetro waitObject después de haber llamado al delegado; es false para indicar que el temporizador se restablece cada vez que se completa la operación de espera, hasta que se anule el registro de espera.

Valor devuelto

Tipo: System.Threading.RegisteredWaitHandle
RegisteredWaitHandle que puede utilizarse para cancelar la operación de espera registrada.

ExcepciónCondición
ArgumentOutOfRangeException

El parámetro millisecondsTimeOutInterval es menor que -1.

Cuando termine de usar la clase RegisteredWaitHandle devuelta por este método, llame a su método RegisteredWaitHandle.Unregister para liberar las referencias al identificador de espera. Se recomienda llamar siempre al método RegisteredWaitHandle.Unregister, incluso si se especifica true para executeOnlyOnce. La recolección de elementos no utilizados resulta más eficaz si se llama al método RegisteredWaitHandle.Unregister en lugar de depender del finalizador del identificador de espera registrado.

El método RegisterWaitForSingleObject coloca el delegado especificado en cola del grupo de subprocesos. Un proceso de trabajo ejecutará el delegado si se produce una de las siguientes situaciones:

  • El objeto especificado se encuentra en estado señalado.

  • El intervalo de tiempo de espera ha transcurrido.

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

Nota importanteImportante

El uso de Mutex para waitObject no proporciona la exclusión mutua de devoluciones de llamada porque la API de Win32 subyacente utiliza el marcador WT_EXECUTEDEFAULT predeterminado, por lo que cada devolución de llamada se envía en un subproceso del grupo de subprocesos independiente. En lugar de un objeto Mutex, utilice un objeto Semaphore cuyo recuento máximo sea 1.

Para cancelar la operación de espera, hay que llamar al método RegisteredWaitHandle.Unregister.

El subproceso de espera utiliza la función WaitForMultipleObjects de Win32 para supervisar las operaciones de espera registradas. Por lo tanto, si tiene que utilizar el mismo identificador del sistema operativo nativo en varias llamadas a RegisterWaitForSingleObject, deberá duplicar el identificador utilizando la función DuplicateHandle de Win32. Tenga en cuanta que no debe marcar un objeto de evento que se haya 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. La modificación se lleva a cabo únicamente en el objeto cuyo estado señalado satisfizo la condición de espera. Por ejemplo, el recuento de un semáforo disminuye en una unidad.

Información de versiones

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

En el ejemplo siguiente se muestra cómo utilizar el método RegisterWaitForSingleObject 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 AutoResetEvent.

En el ejemplo, se define una clase TaskInfo para que contenga la información que se pasa a la devolución de llamada cuando se ejecuta. En el ejemplo, se crea un objeto TaskInfo y se le asignan algunos datos de cadena. El objeto RegisteredWaitHandle que devuelve el método RegisterWaitForSingleObject se asigna al campo Handle del objeto TaskInfo para que el método de devolución de llamada tenga acceso a RegisteredWaitHandle.

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

Cuando el subproceso principal señala el objeto AutoResetEvent mediante una llamada a su método Set, se invoca el delegado WaitOrTimerCallback. El método WaitProc prueba 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 método WaitProc anula el registro de RegisteredWaitHandle, deteniendo las devoluciones de llamada adicionales. En el caso de un tiempo de espera, la tarea sigue esperando. El método WaitProc 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

Compatible con: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Compatible con: 4, 3.5 SP1

Windows 7, Windows Vista SP1 o posterior, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (no se admite Server Core), Windows Server 2008 R2 (se admite Server Core con SP1 o posterior), Windows Server 2003 SP2

.NET Framework no admite todas las versiones de todas las plataformas. Para obtener una lista de las versiones compatibles, vea Requisitos de sistema de .NET Framework.

Adiciones de comunidad

AGREGAR
Mostrar:
© 2014 Microsoft