ThreadPool.RegisterWaitForSingleObject Methode

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, System::UInt32 millisecondsTimeOutInterval, bool executeOnlyOnce);

[System.CLSCompliant(false)]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject(System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, uint millisecondsTimeOutInterval, bool executeOnlyOnce);

[<System.CLSCompliant(false)>]
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * uint32 * bool -> System.Threading.RegisteredWaitHandle

Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, millisecondsTimeOutInterval As UInteger, executeOnlyOnce As Boolean) As RegisteredWaitHandle

Parameter

Gibt zurück

Dies RegisteredWaitHandle kann verwendet werden, um den registrierten Wartevorgang abzubrechen.

Attribute

CLSCompliantAttribute

Ausnahmen

Beispiele

Das folgende Beispiel zeigt, 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

Hinweise

Wenn Sie mit der Verwendung der RegisteredWaitHandle von dieser Methode zurückgegebenen Methode fertig sind, rufen Sie dessen RegisteredWaitHandle.Unregister Methode auf, um Verweise auf das Wartehandle freizugeben. Es wird empfohlen, die RegisteredWaitHandle.Unregister Methode immer aufzurufen, auch wenn Sie dies executeOnlyOnceangebentrue. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister Methode anstelle des Finalizers des registrierten Wartekästchens aufrufen.

Die RegisterWaitForSingleObject Methode stellt den angegebenen Delegat in die Warteschlange des Threadpools. Ein Workerthread führt den Delegaten aus, wenn einer der folgenden Aktionen auftritt:

• Das angegebene Objekt befindet sich im signalisierten Zustand.
• Das Timeoutintervall verstrichen.

Die RegisterWaitForSingleObject Methode überprüft den aktuellen Zustand des angegebenen Objekts WaitHandle. Wenn der Status des Objekts nicht signaliert ist, registriert die Methode einen Wartevorgang. Der Wartevorgang wird von einem Thread aus dem Threadpool ausgeführt. Der Delegat wird von einem Arbeitsthread ausgeführt, wenn der Zustand des Objekts signalisiert wird oder das Timeoutintervall verstrichen ist. Wenn der timeOutInterval Parameter nicht 0 (null) ist und der executeOnlyOnce Parameter lautet false, wird der Timer jedes Mal zurückgesetzt, wenn das Ereignis signalisiert wird oder das Timeoutintervall verstrichen ist.

Rufen Sie die RegisteredWaitHandle.Unregister Methode auf, um den Wartevorgang abzubrechen.

Der Wartethread verwendet die Win32-Funktion WaitForMultipleObjects , um registrierte Wartevorgänge zu überwachen. Wenn Sie daher dasselbe systemeigene Betriebssystemhandle in mehreren Aufrufen RegisterWaitForSingleObjectverwenden müssen, müssen Sie das Handle mit der Win32-Funktion DuplicateHandle duplizieren. Beachten Sie, dass Sie ein an ein Ereignis übergebenes RegisterWaitForSingleObjectEreignisobjekt nicht impulsieren sollten, da der Wartethread möglicherweise nicht erkennt, dass das Ereignis vor dem Zurücksetzen signalisiert wird.

Vor dem Zurückgeben ändert die Funktion den Status einiger Synchronisierungsobjekte. Die Änderung erfolgt nur für das Objekt, dessen signalisierter Zustand dazu führte, dass die Wartebedingung erfüllt wurde. Beispielsweise wird die Anzahl eines Semaphors um eins verringert.

Weitere Informationen

• Der verwaltete Threadpool

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, TimeSpan timeout, bool executeOnlyOnce);

public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject(System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, TimeSpan timeout, bool executeOnlyOnce);

static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * TimeSpan * bool -> System.Threading.RegisteredWaitHandle

Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, timeout As TimeSpan, executeOnlyOnce As Boolean) As RegisteredWaitHandle

Parameter

Gibt zurück

Das RegisteredWaitHandle kapselt den systemeigenen Handle.

Ausnahmen

Hinweise

Wenn Sie mit der Verwendung der RegisteredWaitHandle von dieser Methode zurückgegebenen Methode fertig sind, rufen Sie dessen RegisteredWaitHandle.Unregister Methode auf, um Verweise auf das Wartehandle freizugeben. Es wird empfohlen, die RegisteredWaitHandle.Unregister Methode immer aufzurufen, auch wenn Sie dies executeOnlyOnceangebentrue. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister Methode anstelle des Finalizers des registrierten Wartekästchens aufrufen.

Die RegisterWaitForSingleObject Methode stellt den angegebenen Delegat in die Warteschlange des Threadpools. Ein Workerthread führt den Delegaten aus, wenn einer der folgenden Aktionen auftritt:

• Das angegebene Objekt befindet sich im signalisierten Zustand.
• Das Timeoutintervall verstrichen.

Die RegisterWaitForSingleObject Methode überprüft den aktuellen Zustand des angegebenen Objekts WaitHandle. Wenn der Status des Objekts nicht signaliert ist, registriert die Methode einen Wartevorgang. Der Wartevorgang wird von einem Thread aus dem Threadpool ausgeführt. Der Delegat wird von einem Arbeitsthread ausgeführt, wenn der Zustand des Objekts signalisiert wird oder das Timeoutintervall verstrichen ist. Wenn der timeOutInterval Parameter nicht 0 (null) ist und der executeOnlyOnce Parameter lautet false, wird der Timer jedes Mal zurückgesetzt, wenn das Ereignis signalisiert wird oder das Timeoutintervall verstrichen ist.

Rufen Sie die RegisteredWaitHandle.Unregister Methode auf, um den Wartevorgang abzubrechen.

Der Wartethread verwendet die Win32-Funktion WaitForMultipleObjects , um registrierte Wartevorgänge zu überwachen. Wenn Sie daher dasselbe systemeigene Betriebssystemhandle in mehreren Aufrufen RegisterWaitForSingleObjectverwenden müssen, müssen Sie das Handle mit der Win32-Funktion DuplicateHandle duplizieren. Beachten Sie, dass Sie ein an ein Ereignis übergebenes RegisterWaitForSingleObjectEreignisobjekt nicht impulsieren sollten, da der Wartethread möglicherweise nicht erkennt, dass das Ereignis vor dem Zurücksetzen signalisiert wird.

Vor dem Zurückgeben ändert die Funktion den Status einiger Synchronisierungsobjekte. Die Änderung erfolgt nur für das Objekt, dessen signalisierter Zustand dazu führte, dass die Wartebedingung erfüllt wurde. Beispielsweise wird die Anzahl eines Semaphors um eins verringert.

Weitere Informationen

• Der verwaltete Threadpool

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, long millisecondsTimeOutInterval, bool executeOnlyOnce);

public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject(System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, long millisecondsTimeOutInterval, bool executeOnlyOnce);

static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * int64 * bool -> System.Threading.RegisteredWaitHandle

Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, millisecondsTimeOutInterval As Long, executeOnlyOnce As Boolean) As RegisteredWaitHandle

Parameter

Gibt zurück

Das RegisteredWaitHandle kapselt den systemeigenen Handle.

Ausnahmen

Hinweise

Wenn Sie mit der Verwendung der RegisteredWaitHandle von dieser Methode zurückgegebenen Methode fertig sind, rufen Sie dessen RegisteredWaitHandle.Unregister Methode auf, um Verweise auf das Wartehandle freizugeben. Es wird empfohlen, die RegisteredWaitHandle.Unregister Methode immer aufzurufen, auch wenn Sie dies executeOnlyOnceangebentrue. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister Methode anstelle des Finalizers des registrierten Wartekästchens aufrufen.

Die RegisterWaitForSingleObject Methode stellt den angegebenen Delegat in die Warteschlange des Threadpools. Ein Workerthread führt den Delegaten aus, wenn einer der folgenden Aktionen auftritt:

• Das angegebene Objekt befindet sich im signalisierten Zustand.
• Das Timeoutintervall verstrichen.

Die RegisterWaitForSingleObject Methode überprüft den aktuellen Zustand des angegebenen Objekts WaitHandle. Wenn der Status des Objekts nicht signaliert ist, registriert die Methode einen Wartevorgang. Der Wartevorgang wird von einem Thread aus dem Threadpool ausgeführt. Der Delegat wird von einem Arbeitsthread ausgeführt, wenn der Zustand des Objekts signalisiert wird oder das Timeoutintervall verstrichen ist. Wenn der timeOutInterval Parameter nicht 0 (null) ist und der executeOnlyOnce Parameter lautet false, wird der Timer jedes Mal zurückgesetzt, wenn das Ereignis signalisiert wird oder das Timeoutintervall verstrichen ist.

Rufen Sie die RegisteredWaitHandle.Unregister Methode auf, um den Wartevorgang abzubrechen.

Der Wartethread verwendet die Win32-Funktion WaitForMultipleObjects , um registrierte Wartevorgänge zu überwachen. Wenn Sie daher dasselbe systemeigene Betriebssystemhandle in mehreren Aufrufen RegisterWaitForSingleObjectverwenden müssen, müssen Sie das Handle mit der Win32-Funktion DuplicateHandle duplizieren. Beachten Sie, dass Sie ein an ein Ereignis übergebenes RegisterWaitForSingleObjectEreignisobjekt nicht impulsieren sollten, da der Wartethread möglicherweise nicht erkennt, dass das Ereignis vor dem Zurücksetzen signalisiert wird.

Vor dem Zurückgeben ändert die Funktion den Status einiger Synchronisierungsobjekte. Die Änderung erfolgt nur für das Objekt, dessen signalisierter Zustand dazu führte, dass die Wartebedingung erfüllt wurde. Beispielsweise wird die Anzahl eines Semaphors um eins verringert.

Weitere Informationen

• Der verwaltete Threadpool

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, int millisecondsTimeOutInterval, bool executeOnlyOnce);

public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject(System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, int millisecondsTimeOutInterval, bool executeOnlyOnce);

static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * int * bool -> System.Threading.RegisteredWaitHandle

Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, millisecondsTimeOutInterval As Integer, executeOnlyOnce As Boolean) As RegisteredWaitHandle

Parameter

Gibt zurück

Das RegisteredWaitHandle kapselt den systemeigenen Handle.

Ausnahmen

Hinweise

Wenn Sie mit der Verwendung der RegisteredWaitHandle von dieser Methode zurückgegebenen Methode fertig sind, rufen Sie dessen RegisteredWaitHandle.Unregister Methode auf, um Verweise auf das Wartehandle freizugeben. Es wird empfohlen, die RegisteredWaitHandle.Unregister Methode immer aufzurufen, auch wenn Sie dies executeOnlyOnceangebentrue. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister Methode anstelle des Finalizers des registrierten Wartekästchens aufrufen.

Die RegisterWaitForSingleObject Methode stellt den angegebenen Delegat in die Warteschlange des Threadpools. Ein Workerthread führt den Delegaten aus, wenn einer der folgenden Aktionen auftritt:

• Das angegebene Objekt befindet sich im signalisierten Zustand.
• Das Timeoutintervall verstrichen.

Die RegisterWaitForSingleObject Methode überprüft den aktuellen Zustand des angegebenen Objekts WaitHandle. Wenn der Status des Objekts nicht signaliert ist, registriert die Methode einen Wartevorgang. Der Wartevorgang wird von einem Thread aus dem Threadpool ausgeführt. Der Delegat wird von einem Arbeitsthread ausgeführt, wenn der Zustand des Objekts signalisiert wird oder das Timeoutintervall verstrichen ist. Wenn der timeOutInterval Parameter nicht 0 (null) ist und der executeOnlyOnce Parameter lautet false, wird der Timer jedes Mal zurückgesetzt, wenn das Ereignis signalisiert wird oder das Timeoutintervall verstrichen ist.

Rufen Sie die RegisteredWaitHandle.Unregister Methode auf, um den Wartevorgang abzubrechen.

Der Wartethread verwendet die Win32-Funktion WaitForMultipleObjects , um registrierte Wartevorgänge zu überwachen. Wenn Sie daher dasselbe systemeigene Betriebssystemhandle in mehreren Aufrufen RegisterWaitForSingleObjectverwenden müssen, müssen Sie das Handle mit der Win32-Funktion DuplicateHandle duplizieren. Beachten Sie, dass Sie ein an ein Ereignis übergebenes RegisterWaitForSingleObjectEreignisobjekt nicht impulsieren sollten, da der Wartethread möglicherweise nicht erkennt, dass das Ereignis vor dem Zurücksetzen signalisiert wird.

Vor dem Zurückgeben ändert die Funktion den Status einiger Synchronisierungsobjekte. Die Änderung erfolgt nur für das Objekt, dessen signalisierter Zustand dazu führte, dass die Wartebedingung erfüllt wurde. Beispielsweise wird die Anzahl eines Semaphors um eins verringert.

Weitere Informationen

• Der verwaltete Threadpool