RegisteredWaitHandle Klasse

Definition

public ref class RegisteredWaitHandle sealed : MarshalByRefObject

public sealed class RegisteredWaitHandle : MarshalByRefObject

[System.Runtime.InteropServices.ComVisible(true)]
public sealed class RegisteredWaitHandle : MarshalByRefObject

type RegisteredWaitHandle = class
    inherit MarshalByRefObject

[<System.Runtime.InteropServices.ComVisible(true)>]
type RegisteredWaitHandle = class
    inherit MarshalByRefObject

Public NotInheritable Class RegisteredWaitHandle
Inherits MarshalByRefObject

Vererbung

Object

MarshalByRefObject

RegisteredWaitHandle

Attribute

ComVisibleAttribute

Beispiele

Das folgende Beispiel zeigt, wie Sie mithilfe einer Methode RegisteredWaitHandle ermitteln, warum eine Rückrufmethode aufgerufen wird, und wie Sie die Registrierung einer Aufgabe aufheben, wenn der Rückruf aufgetreten ist, da das Wartekästchen signalisiert wurde.

Das Beispiel zeigt auch, wie die RegisterWaitForSingleObject Methode zum Ausführen einer angegebenen Rückrufmethode verwendet wird, wenn ein angegebenes Wartekästchen signalisiert wird. In diesem Beispiel lautet WaitProcdie Rückrufmethode , und der Warteziehpunkt ist ein AutoResetEvent.

Im Beispiel wird eine TaskInfo Klasse definiert, die die Informationen enthält, die beim Ausführen an den Rückruf übergeben werden. Im Beispiel wird ein TaskInfo Objekt erstellt und ihm einige Zeichenfolgendaten zugewiesen. Das RegisteredWaitHandle von der RegisterWaitForSingleObject Methode zurückgegebene Objekt wird dem Handle Feld des TaskInfo Objekts zugewiesen, sodass die Rückrufmethode Zugriff auf die RegisteredWaitHandle.

Zusätzlich zum Angeben TaskInfo des Objekts, das an die Rückrufmethode übergeben werden soll, gibt der Aufruf der RegisterWaitForSingleObject Methode an AutoResetEvent , dass die Aufgabe wartet, einen WaitOrTimerCallback Delegaten, der die WaitProc Rückrufmethode, ein ein zweites Timeoutintervall und mehrere Rückrufe darstellt.

Wenn der Hauptthread die AutoResetEvent Methode aufruft Set , wird der WaitOrTimerCallback Delegate aufgerufen. Die WaitProc Methode prüft RegisteredWaitHandle , ob ein Timeout aufgetreten ist. Wenn der Rückruf aufgerufen wurde, weil das Wartekästchen signalisiert wurde, hebt die WaitProc Methode die Registrierung auf RegisteredWaitHandleund beendet zusätzliche Rückrufe. Im Falle eines Timeouts wartet der Vorgang weiterhin. Die WaitProc Methode endet mit dem Drucken einer Nachricht in der Konsole.

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
        );
    }
}

Imports System.Threading

' TaskInfo contains data that will be passed to the callback
' method.
Public Class TaskInfo
    public Handle As RegisteredWaitHandle = Nothing
    public OtherInfo As String = "default"
End Class

Public Class Example

    <MTAThread> _
    Public Shared Sub Main()
        ' The main thread uses AutoResetEvent to signal the
        ' registered wait handle, which executes the callback
        ' method.
        Dim ev As New AutoResetEvent(false)

        Dim ti As 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(AddressOf WaitProc), _
            ti, _
            1000, _
            false _
        )

        ' The main thread waits about three seconds, to demonstrate 
        ' the time-outs on the queued task, 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.
    End Sub
   
    ' 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 Shared Sub WaitProc(state As Object, timedOut As Boolean)
        ' The state object must be cast to the correct type, because the
        ' signature of the WaitOrTimerCallback delegate specifies type
        ' Object.
        Dim ti As TaskInfo = CType(state, TaskInfo)

        Dim cause As String = "TIMED OUT"
        If Not timedOut Then
            cause = "SIGNALED"
            ' If the callback method executes because the WaitHandle is
            ' signaled, stop future execution of the callback method
            ' by unregistering the WaitHandle.
            If Not ti.Handle Is Nothing Then
                ti.Handle.Unregister(Nothing)
            End If
        End If 

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

Threadsicherheit

Dieser Typ ist threadsicher.

Weitere Informationen

• Der verwaltete Threadpool