ThreadPool.RegisterWaitForSingleObject Methode

Definition

Registriert einen Delegaten, der auf ein WaitHandle wartet.

Überlädt

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, UInt32, Boolean)

Registriert einen Delegaten, der auf eine WaitHandle-Klasse wartet, wobei für das Timeout in Millisekunden eine 32-Bit-Ganzzahl ohne Vorzeichen angegeben wird.

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, TimeSpan, Boolean)

Registriert einen Delegaten, der auf ein WaitHandle wartet, und gibt einen TimeSpan-Wert für das Timeout an.

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int32, Boolean)

Registriert einen Delegaten, der auf eine WaitHandle-Klasse wartet, wobei für das Timeout in Millisekunden eine 32-Bit-Ganzzahl mit Vorzeichen angegeben wird.

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int64, Boolean)

Registriert einen Delegaten, der auf eine WaitHandle-Klasse wartet, wobei für das Timeout in Millisekunden eine 64-Bit-Ganzzahl mit Vorzeichen angegeben wird.

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, UInt32, Boolean)

Wichtig

Diese API ist nicht CLS-kompatibel.

Registriert einen Delegaten, der auf eine WaitHandle-Klasse wartet, wobei für das Timeout in Millisekunden eine 32-Bit-Ganzzahl ohne Vorzeichen angegeben wird.

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)]
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, uint 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)]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, uint millisecondsTimeOutInterval, bool executeOnlyOnce);
[<System.CLSCompliant(false)>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * uint32 * bool -> System.Threading.RegisteredWaitHandle
[<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

waitObject
WaitHandle

Die zu registrierende WaitHandle. Verwenden Sie ein anderes WaitHandle als Mutex.

callBack
WaitOrTimerCallback

Der WaitOrTimerCallback-Delegat, der aufgerufen werden soll, wenn der waitObject-Parameter signalisiert wird.

state
Object

Das an den Delegaten übergebene Objekt.

millisecondsTimeOutInterval
UInt32

Das Timeout in Millisekunden. Wenn der millisecondsTimeOutInterval-Parameter 0 (null) ist, prüft die Funktion den Zustand des Objekts und kehrt sofort zurück. Wenn millisecondsTimeOutInterval den Wert -1 hat, läuft das Timeoutintervall der Funktion nie ab.

executeOnlyOnce
Boolean

true, um anzugeben, dass der Thread nach dem Aufruf des Delegaten nicht mehr auf den waitObject-Parameter warten soll. false, um anzugeben, dass der Zeitgeber nach jedem Abschluss des Wartevorgangs zurückgesetzt wird, bis die Registrierung des Wartevorgangs aufgehoben wird.

Gibt zurück

RegisteredWaitHandle

Das RegisteredWaitHandle, mit dem der registrierte Wartevorgang abgebrochen werden kann.

Attribute

Ausnahmen

Der millisecondsTimeOutInterval-Parameter ist kleiner als -1.

Beispiele

Im folgenden Beispiel wird gezeigt, wie die Methode zum Ausführen einer angegebenen Rückrufmethode verwendet RegisterWaitForSingleObject wird, wenn ein angegebenes Wartenhandpunkt signalisiert wird. In diesem Beispiel ist WaitProcdie Rückrufmethode , und der Wartenpunkt ist ein AutoResetEvent.

Im Beispiel wird eine TaskInfo Klasse definiert, um die Informationen zu halten, die an den Rückruf übergeben werden, wenn er ausgeführt wird. Das Beispiel erstellt ein TaskInfo Objekt und weist ihm einige Zeichenfolgendaten zu. Das RegisteredWaitHandle durch die RegisterWaitForSingleObject Methode zurückgegebene Objekt wird dem Handle Feld des TaskInfo Objekts zugewiesen, sodass die Rückrufmethode Zugriff auf das RegisteredWaitHandleObjekt hat.

Zusätzlich zum Angeben TaskInfo des Objekts, das an die Rückrufmethode übergeben werden soll, gibt der Aufruf RegisterWaitForSingleObject an die Methode anAutoResetEvent, dass die Aufgabe warten wird, eine Stellvertretung, die die WaitProc Rückrufmethode, ein WaitOrTimerCallback zweites Timeoutintervall und mehrere Rückrufe darstellt.

Wenn der Hauptthread die AutoResetEvent Methode aufruft Set , wird der WaitOrTimerCallback Stellvertretung aufgerufen. Die WaitProc Methode prüft RegisteredWaitHandle , ob ein Timeout aufgetreten ist. Wenn der Rückruf aufgerufen wurde, weil der Wartenhandpunkt signalisiert wurde, wird die WaitProc Methode die Registrierung RegisteredWaitHandleaufheben, indem zusätzliche Rückrufe beendet werden. Im Falle eines Timeouts wartet die Aufgabe weiterhin. Die WaitProc Methode endet mit dem Drucken einer Nachricht in die Konsole.

using namespace System;
using namespace System::Threading;

// TaskInfo contains data that will be passed to the callback
// method.
public ref class TaskInfo
{
public:
   TaskInfo()
   {
      Handle = nullptr;
      OtherInfo = "default";
   }

   RegisteredWaitHandle^ Handle;
   String^ OtherInfo;
};

ref class Example
{
public:

   // 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.
   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 = static_cast<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 != nullptr )
                  ti->Handle->Unregister( nullptr );
      }

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

};

int main()
{
   
   // The main thread uses AutoResetEvent to signal the
   // registered wait handle, which executes the callback
   // method.
   AutoResetEvent^ ev = gcnew AutoResetEvent( false );
   TaskInfo^ ti = gcnew 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, gcnew WaitOrTimerCallback( Example::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.
   return 0;
}
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 die RegisteredWaitHandle Verwendung der von dieser Methode zurückgegebenen Methode abgeschlossen haben, rufen Sie die RegisteredWaitHandle.Unregister Methode auf, um Verweise auf den Wartenpunkt zu freigeben. Wir empfehlen, dass Sie die RegisteredWaitHandle.Unregister Methode immer aufrufen, auch wenn Sie true executeOnlyOnceangeben. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister Methode anstelle des Finalizers des registrierten Wartens aufrufen.

Die RegisterWaitForSingleObject Methode warteschlange die angegebene Stellvertretung an den Threadpool. Ein Arbeitsthread führt den Stellvertretung aus, wenn eine der folgenden Schritte auftritt:

  • Das angegebene Objekt befindet sich im signalierten Zustand.

  • Das Timeoutintervall verfällt.

Die RegisterWaitForSingleObject Methode überprüft den aktuellen Zustand des angegebenen Objekts WaitHandle. Wenn der Zustand des Objekts nicht signaliert ist, registriert die Methode einen Wartenvorgang. Der Wartenvorgang wird von einem Thread aus dem Threadpool ausgeführt. Der Stellvertretung wird von einem Arbeitsthread ausgeführt, wenn der Zustand des Objekts signalisiert wird oder das Timeoutintervall abgelaufen ist. Wenn der timeOutInterval Parameter nicht 0 (Null) ist und der executeOnlyOnce Parameter falselautet, wird der Zeitgeber jedes Mal zurückgesetzt, wenn das Ereignis signalisiert wird oder das Timeoutintervall abgelaufen ist.

Wichtig

Die Verwendung einer Mutex For waitObject bietet keinen gegenseitigen Ausschluss für die Rückrufe, da die zugrunde liegende Windows-API das Standard-Flag WT_EXECUTEDEFAULT verwendet, sodass jeder Rückruf auf einem separaten Threadpoolthread verteilt wird. Statt einer Mutex, verwenden Sie eine Semaphore mit einer maximalen Anzahl von 1.

Um den Wartenvorgang abzubrechen, rufen Sie die RegisteredWaitHandle.Unregister Methode auf.

Der Wartenthread verwendet die Win32-Funktion WaitForMultipleObjects , um registrierte Wartenvorgänge zu überwachen. Wenn Sie daher den gleichen systemeigenen Betriebssystemhandpunkt in mehreren Aufrufen RegisterWaitForSingleObjectverwenden müssen, müssen Sie den Handle mit der Win32-Funktion DuplicateHandle duplizieren. Beachten Sie, dass Sie kein Ereignisobjekt animieren sollten, an das sie übergeben RegisterWaitForSingleObjectwurde, da der Wartenthread möglicherweise nicht erkennt, dass das Ereignis vor dem Zurücksetzen signalisiert wird.

Vor der Rückgabe ändert die Funktion den Zustand einiger Synchronisierungsobjekte. Die Änderung tritt nur für das Objekt auf, dessen signalisierter Zustand die Wartenbedingung erfüllt hat. Beispielsweise wird die Anzahl einer Semaphore von einem verringert.

Versionsinformationen

Ab der .NET Framework Version 2.0 wird der Thread.CurrentPrincipal Eigenschaftswert mithilfe der RegisterWaitForSingleObject Methode an Arbeitsthreads verteilt. In früheren Versionen wird die Hauptinformationen nicht verteilt.

Siehe auch

Gilt für:

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, TimeSpan, Boolean)

Registriert einen Delegaten, der auf ein WaitHandle wartet, und gibt einen TimeSpan-Wert für das Timeout an.

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, TimeSpan timeout, bool executeOnlyOnce);
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, 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);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, TimeSpan timeout, bool executeOnlyOnce);
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * TimeSpan * bool -> System.Threading.RegisteredWaitHandle
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

waitObject
WaitHandle

Die zu registrierende WaitHandle. Verwenden Sie ein anderes WaitHandle als Mutex.

callBack
WaitOrTimerCallback

Der WaitOrTimerCallback-Delegat, der aufgerufen werden soll, wenn der waitObject-Parameter signalisiert wird.

state
Object

Das an den Delegaten übergebene Objekt.

timeout
TimeSpan

Das durch eine TimeSpan dargestellte Timeout. Wenn timeout den Wert 0 (null) hat, prüft die Funktion den Zustand des Objekts und kehrt sofort zurück. Wenn timeout den Wert -1 hat, läuft das Timeoutintervall der Funktion nie ab.

executeOnlyOnce
Boolean

true, um anzugeben, dass der Thread nach dem Aufruf des Delegaten nicht mehr auf den waitObject-Parameter warten soll. false, um anzugeben, dass der Zeitgeber nach jedem Abschluss des Wartevorgangs zurückgesetzt wird, bis die Registrierung des Wartevorgangs aufgehoben wird.

Gibt zurück

RegisteredWaitHandle

Das RegisteredWaitHandle, das das systemeigene Handle kapselt.

Attribute

Ausnahmen

Der timeout-Parameter ist kleiner als -1.

Der timeout Parameter ist größer als Int32.MaxValue.

Hinweise

Wenn Sie die RegisteredWaitHandle Verwendung der von dieser Methode zurückgegebenen Methode abgeschlossen haben, rufen Sie die RegisteredWaitHandle.Unregister Methode auf, um Verweise auf den Wartenpunkt zu freigeben. Wir empfehlen, dass Sie die RegisteredWaitHandle.Unregister Methode immer aufrufen, auch wenn Sie true executeOnlyOnceangeben. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister Methode anstelle des Finalizers des registrierten Wartens aufrufen.

Die RegisterWaitForSingleObject Methode warteschlange die angegebene Stellvertretung an den Threadpool. Ein Arbeitsthread führt den Stellvertretung aus, wenn eine der folgenden Schritte auftritt:

  • Das angegebene Objekt befindet sich im signalierten Zustand.

  • Das Timeoutintervall verfällt.

Die RegisterWaitForSingleObject Methode überprüft den aktuellen Zustand des angegebenen Objekts WaitHandle. Wenn der Zustand des Objekts nicht signaliert ist, registriert die Methode einen Wartenvorgang. Der Wartenvorgang wird von einem Thread aus dem Threadpool ausgeführt. Der Stellvertretung wird von einem Arbeitsthread ausgeführt, wenn der Zustand des Objekts signalisiert wird oder das Timeoutintervall abgelaufen ist. Wenn der timeOutInterval Parameter nicht 0 (Null) ist und der executeOnlyOnce Parameter falselautet, wird der Zeitgeber jedes Mal zurückgesetzt, wenn das Ereignis signalisiert wird oder das Timeoutintervall abgelaufen ist.

Wichtig

Die Verwendung einer Mutex For waitObject bietet keinen gegenseitigen Ausschluss für die Rückrufe, da die zugrunde liegende Windows-API das Standard-Flag WT_EXECUTEDEFAULT verwendet, sodass jeder Rückruf auf einem separaten Threadpoolthread verteilt wird. Statt einer Mutex, verwenden Sie eine Semaphore mit einer maximalen Anzahl von 1.

Um den Wartenvorgang abzubrechen, rufen Sie die RegisteredWaitHandle.Unregister Methode auf.

Der Wartenthread verwendet die Win32-Funktion WaitForMultipleObjects , um registrierte Wartenvorgänge zu überwachen. Wenn Sie daher den gleichen systemeigenen Betriebssystemhandpunkt in mehreren Aufrufen RegisterWaitForSingleObjectverwenden müssen, müssen Sie den Handle mit der Win32-Funktion DuplicateHandle duplizieren. Beachten Sie, dass Sie kein Ereignisobjekt animieren sollten, an das sie übergeben RegisterWaitForSingleObjectwurde, da der Wartenthread möglicherweise nicht erkennt, dass das Ereignis vor dem Zurücksetzen signalisiert wird.

Vor der Rückgabe ändert die Funktion den Zustand einiger Synchronisierungsobjekte. Die Änderung tritt nur für das Objekt auf, dessen signalisierter Zustand die Wartenbedingung erfüllt hat. Beispielsweise wird die Anzahl einer Semaphore von einem verringert.

Versionsinformationen

Ab der .NET Framework Version 2.0 wird der Thread.CurrentPrincipal Eigenschaftswert mithilfe der RegisterWaitForSingleObject Methode an Arbeitsthreads verteilt. In früheren Versionen wird die Hauptinformationen nicht verteilt.

Siehe auch

Gilt für:

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int32, Boolean)

Registriert einen Delegaten, der auf eine WaitHandle-Klasse wartet, wobei für das Timeout in Millisekunden eine 32-Bit-Ganzzahl mit Vorzeichen angegeben wird.

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, int millisecondsTimeOutInterval, bool executeOnlyOnce);
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, 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);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, int millisecondsTimeOutInterval, bool executeOnlyOnce);
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * int * bool -> System.Threading.RegisteredWaitHandle
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

waitObject
WaitHandle

Die zu registrierende WaitHandle. Verwenden Sie ein anderes WaitHandle als Mutex.

callBack
WaitOrTimerCallback

Der WaitOrTimerCallback-Delegat, der aufgerufen werden soll, wenn der waitObject-Parameter signalisiert wird.

state
Object

Das an den Delegaten übergebene Objekt.

millisecondsTimeOutInterval
Int32

Das Timeout in Millisekunden. Wenn der millisecondsTimeOutInterval-Parameter 0 (null) ist, prüft die Funktion den Zustand des Objekts und kehrt sofort zurück. Wenn millisecondsTimeOutInterval den Wert -1 hat, läuft das Timeoutintervall der Funktion nie ab.

executeOnlyOnce
Boolean

true, um anzugeben, dass der Thread nach dem Aufruf des Delegaten nicht mehr auf den waitObject-Parameter warten soll. false, um anzugeben, dass der Zeitgeber nach jedem Abschluss des Wartevorgangs zurückgesetzt wird, bis die Registrierung des Wartevorgangs aufgehoben wird.

Gibt zurück

RegisteredWaitHandle

Das RegisteredWaitHandle, das das systemeigene Handle kapselt.

Attribute

Ausnahmen

Der millisecondsTimeOutInterval-Parameter ist kleiner als -1.

Hinweise

Wenn Sie die RegisteredWaitHandle Verwendung der von dieser Methode zurückgegebenen Methode abgeschlossen haben, rufen Sie die RegisteredWaitHandle.Unregister Methode auf, um Verweise auf den Wartenpunkt zu freigeben. Wir empfehlen, dass Sie die RegisteredWaitHandle.Unregister Methode immer aufrufen, auch wenn Sie true executeOnlyOnceangeben. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister Methode anstelle des Finalizers des registrierten Wartens aufrufen.

Die RegisterWaitForSingleObject Methode warteschlange die angegebene Stellvertretung an den Threadpool. Ein Arbeitsthread führt den Stellvertretung aus, wenn eine der folgenden Schritte auftritt:

  • Das angegebene Objekt befindet sich im signalierten Zustand.

  • Das Timeoutintervall verfällt.

Die RegisterWaitForSingleObject Methode überprüft den aktuellen Zustand des angegebenen Objekts WaitHandle. Wenn der Zustand des Objekts nicht signaliert ist, registriert die Methode einen Wartenvorgang. Der Wartenvorgang wird von einem Thread aus dem Threadpool ausgeführt. Der Stellvertretung wird von einem Arbeitsthread ausgeführt, wenn der Zustand des Objekts signalisiert wird oder das Timeoutintervall abgelaufen ist. Wenn der timeOutInterval Parameter nicht 0 (Null) ist und der executeOnlyOnce Parameter falselautet, wird der Zeitgeber jedes Mal zurückgesetzt, wenn das Ereignis signalisiert wird oder das Timeoutintervall abgelaufen ist.

Wichtig

Die Verwendung einer Mutex For waitObject bietet keinen gegenseitigen Ausschluss für die Rückrufe, da die zugrunde liegende Windows-API das Standard-Flag WT_EXECUTEDEFAULT verwendet, sodass jeder Rückruf auf einem separaten Threadpoolthread verteilt wird. Statt einer Mutex, verwenden Sie eine Semaphore mit einer maximalen Anzahl von 1.

Um den Wartenvorgang abzubrechen, rufen Sie die RegisteredWaitHandle.Unregister Methode auf.

Der Wartenthread verwendet die Win32-Funktion WaitForMultipleObjects , um registrierte Wartenvorgänge zu überwachen. Wenn Sie daher den gleichen systemeigenen Betriebssystemhandpunkt in mehreren Aufrufen RegisterWaitForSingleObjectverwenden müssen, müssen Sie den Handle mit der Win32-Funktion DuplicateHandle duplizieren. Beachten Sie, dass Sie kein Ereignisobjekt animieren sollten, an das sie übergeben RegisterWaitForSingleObjectwurde, da der Wartenthread möglicherweise nicht erkennt, dass das Ereignis vor dem Zurücksetzen signalisiert wird.

Vor der Rückgabe ändert die Funktion den Zustand einiger Synchronisierungsobjekte. Die Änderung tritt nur für das Objekt auf, dessen signalisierter Zustand die Wartenbedingung erfüllt hat. Beispielsweise wird die Anzahl einer Semaphore von einem verringert.

Versionsinformationen

Ab der .NET Framework Version 2.0 wird der Thread.CurrentPrincipal Eigenschaftswert mithilfe der RegisterWaitForSingleObject Methode an Arbeitsthreads verteilt. In früheren Versionen wird die Hauptinformationen nicht verteilt.

Siehe auch

Gilt für:

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int64, Boolean)

Registriert einen Delegaten, der auf eine WaitHandle-Klasse wartet, wobei für das Timeout in Millisekunden eine 64-Bit-Ganzzahl mit Vorzeichen angegeben wird.

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, long millisecondsTimeOutInterval, bool executeOnlyOnce);
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, 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);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, long millisecondsTimeOutInterval, bool executeOnlyOnce);
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * int64 * bool -> System.Threading.RegisteredWaitHandle
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

waitObject
WaitHandle

Die zu registrierende WaitHandle. Verwenden Sie ein anderes WaitHandle als Mutex.

callBack
WaitOrTimerCallback

Der WaitOrTimerCallback-Delegat, der aufgerufen werden soll, wenn der waitObject-Parameter signalisiert wird.

state
Object

Das an den Delegaten übergebene Objekt.

millisecondsTimeOutInterval
Int64

Das Timeout in Millisekunden. Wenn der millisecondsTimeOutInterval-Parameter 0 (null) ist, prüft die Funktion den Zustand des Objekts und kehrt sofort zurück. Wenn millisecondsTimeOutInterval den Wert -1 hat, läuft das Timeoutintervall der Funktion nie ab.

executeOnlyOnce
Boolean

true, um anzugeben, dass der Thread nach dem Aufruf des Delegaten nicht mehr auf den waitObject-Parameter warten soll. false, um anzugeben, dass der Zeitgeber nach jedem Abschluss des Wartevorgangs zurückgesetzt wird, bis die Registrierung des Wartevorgangs aufgehoben wird.

Gibt zurück

RegisteredWaitHandle

Das RegisteredWaitHandle, das das systemeigene Handle kapselt.

Attribute

Ausnahmen

Der millisecondsTimeOutInterval-Parameter ist kleiner als -1.

Hinweise

Wenn Sie die RegisteredWaitHandle Verwendung der von dieser Methode zurückgegebenen Methode abgeschlossen haben, rufen Sie die RegisteredWaitHandle.Unregister Methode auf, um Verweise auf den Wartenpunkt zu freigeben. Wir empfehlen, dass Sie die RegisteredWaitHandle.Unregister Methode immer aufrufen, auch wenn Sie true executeOnlyOnceangeben. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister Methode anstelle des Finalizers des registrierten Wartens aufrufen.

Die RegisterWaitForSingleObject Methode warteschlange die angegebene Stellvertretung an den Threadpool. Ein Arbeitsthread führt den Stellvertretung aus, wenn eine der folgenden Schritte auftritt:

  • Das angegebene Objekt befindet sich im signalierten Zustand.

  • Das Timeoutintervall verfällt.

Die RegisterWaitForSingleObject Methode überprüft den aktuellen Zustand des angegebenen Objekts WaitHandle. Wenn der Zustand des Objekts nicht signaliert ist, registriert die Methode einen Wartenvorgang. Der Wartenvorgang wird von einem Thread aus dem Threadpool ausgeführt. Der Stellvertretung wird von einem Arbeitsthread ausgeführt, wenn der Zustand des Objekts signalisiert wird oder das Timeoutintervall abgelaufen ist. Wenn der timeOutInterval Parameter nicht 0 (Null) ist und der executeOnlyOnce Parameter falselautet, wird der Zeitgeber jedes Mal zurückgesetzt, wenn das Ereignis signalisiert wird oder das Timeoutintervall abgelaufen ist.

Wichtig

Die Verwendung einer Mutex For waitObject bietet keinen gegenseitigen Ausschluss für die Rückrufe, da die zugrunde liegende Windows-API das Standard-Flag WT_EXECUTEDEFAULT verwendet, sodass jeder Rückruf auf einem separaten Threadpoolthread verteilt wird. Statt einer Mutex, verwenden Sie eine Semaphore mit einer maximalen Anzahl von 1.

Um den Wartenvorgang abzubrechen, rufen Sie die RegisteredWaitHandle.Unregister Methode auf.

Der Wartenthread verwendet die Win32-Funktion WaitForMultipleObjects , um registrierte Wartenvorgänge zu überwachen. Wenn Sie daher den gleichen systemeigenen Betriebssystemhandpunkt in mehreren Aufrufen RegisterWaitForSingleObjectverwenden müssen, müssen Sie den Handle mit der Win32-Funktion DuplicateHandle duplizieren. Beachten Sie, dass Sie kein Ereignisobjekt animieren sollten, an das sie übergeben RegisterWaitForSingleObjectwurde, da der Wartenthread möglicherweise nicht erkennt, dass das Ereignis vor dem Zurücksetzen signalisiert wird.

Vor der Rückgabe ändert die Funktion den Zustand einiger Synchronisierungsobjekte. Die Änderung tritt nur für das Objekt auf, dessen signalisierter Zustand die Wartenbedingung erfüllt hat. Beispielsweise wird die Anzahl einer Semaphore von einem verringert.

Versionsinformationen

Ab der .NET Framework Version 2.0 wird der Thread.CurrentPrincipal Eigenschaftswert mithilfe der RegisterWaitForSingleObject Methode an Arbeitsthreads verteilt. In früheren Versionen wird die Hauptinformationen nicht verteilt.

Siehe auch

Gilt für: