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 RegisteredWaitHandle.Unregister (WaitHandle)

 

Publicado: octubre de 2016

Cancela una operación de espera registrada emitida por la RegisterWaitForSingleObject (método).

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

[ComVisibleAttribute(true)]
public bool Unregister(
	WaitHandle waitObject
)

Parámetros

waitObject
Type: System.Threading.WaitHandle

El WaitHandle a señalar.

Valor devuelto

Type: System.Boolean

true Si la función se realiza correctamente; de lo contrario, false.

Si waitObject se especifica, se lo señala sólo si el RegisteredWaitHandle está registrado correctamente. Si un método de devolución de llamada está en curso cuando Unregister se ejecuta, waitObject no se señala hasta que se complete el método de devolución de llamada. En concreto, si se ejecuta un método de devolución de llamada Unregister, waitObject no se señala hasta que dicho método finaliza.

En el ejemplo siguiente se muestra cómo utilizar el Unregister método para anular el registro de una tarea si se produjo una devolución de llamada porque se señaló el identificador de espera.

El ejemplo también 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: