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

Das folgende Beispiel zeigt, wie Sie die RegisterWaitForSingleObject -Methode verwenden, um eine angegebene Rückrufmethode auszuführen, wenn ein angegebenes Wartehandle signalisiert wird. In diesem Beispiel ist WaitProcdie Rückrufmethode , und das Wartehandle 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 Zeichenfolgendaten zugewiesen. Das RegisteredWaitHandle von der RegisterWaitForSingleObject -Methode zurückgegebene wird dem Handle Feld des TaskInfo -Objekts zugewiesen, sodass die Rückrufmethode Zugriff auf hat RegisteredWaitHandle.

Neben der Angabe TaskInfo als Objekt, das an die Rückrufmethode übergeben werden soll, gibt der Aufruf der -Methode das RegisterWaitForSingleObjectAutoResetEvent an, auf das der Task wartet, einen WaitOrTimerCallback Delegaten, der die WaitProc Rückrufmethode darstellt, ein Timeoutintervall von einer Sekunde und mehrere Rückrufe.

Wenn der Hauptthread signalisiert, indem er seine AutoResetEventSet Methode aufruft, wird der WaitOrTimerCallback Delegat aufgerufen. Die WaitProc Methode testet RegisteredWaitHandle , um zu ermitteln, ob ein Timeout aufgetreten ist. Wenn der Rückruf aufgerufen wurde, weil das Wartehandle signalisiert wurde, hebt die -Methode die WaitProc Registrierung auf RegisteredWaitHandle, und beendet zusätzliche Rückrufe. Bei einem Timeout wartet die Aufgabe weiterhin. Die WaitProc Methode endet mit dem Drucken einer Nachricht an 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 von dieser Methode zurückgegebene Methode verwendet haben, rufen Sie deren RegisteredWaitHandle.Unregister Methode auf, um Verweise auf das Wartehandle freizugeben. Es wird empfohlen, die RegisteredWaitHandle.Unregister -Methode immer aufzurufen, auch wenn Sie für executeOnlyOnceangebentrue. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister Methode aufrufen, anstatt vom Finalizer des registrierten Wartehandles abhängig zu sein.

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

  • Das angegebene Objekt befindet sich im signalierten Zustand.

  • Das Timeoutintervall verstreicht.

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

Wichtig

Die Verwendung eines Mutex für waitObject bietet keinen gegenseitigen Ausschluss für die Rückrufe, da die zugrunde liegende Windows-API das Standardflag WT_EXECUTEDEFAULT verwendet, sodass jeder Rückruf für einen separaten Threadpoolthread gesendet wird. Verwenden Sie anstelle eines Mutexeine Semaphore mit einer maximalen Anzahl von 1.

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

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

Vor der Rückgabe ändert die Funktion den Zustand einiger Typen von Synchronisierungsobjekten. Die Änderung erfolgt nur für das Objekt, dessen signalisierter Zustand die Wartebedingung erfüllt hat. Beispielsweise wird die Anzahl eines Semaphors um eins verringert.

Versionsinformationen

Ab .NET Framework Version 2.0 wird der Thread.CurrentPrincipal Eigenschaftswert an Workerthreads weitergegeben, die mithilfe der -Methode in die RegisterWaitForSingleObject Warteschlange gestellt werden. In früheren Versionen werden die Prinzipalinformationen nicht weitergegeben.

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 von dieser Methode zurückgegebene Methode verwendet haben, rufen Sie deren RegisteredWaitHandle.Unregister Methode auf, um Verweise auf das Wartehandle freizugeben. Es wird empfohlen, die RegisteredWaitHandle.Unregister -Methode immer aufzurufen, auch wenn Sie für executeOnlyOnceangebentrue. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister Methode aufrufen, anstatt vom Finalizer des registrierten Wartehandles abhängig zu sein.

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

  • Das angegebene Objekt befindet sich im signalierten Zustand.

  • Das Timeoutintervall verstreicht.

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

Wichtig

Die Verwendung eines Mutex für waitObject bietet keinen gegenseitigen Ausschluss für die Rückrufe, da die zugrunde liegende Windows-API das Standardflag WT_EXECUTEDEFAULT verwendet, sodass jeder Rückruf für einen separaten Threadpoolthread gesendet wird. Verwenden Sie anstelle eines Mutexeine Semaphore mit einer maximalen Anzahl von 1.

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

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

Vor der Rückgabe ändert die Funktion den Zustand einiger Typen von Synchronisierungsobjekten. Die Änderung erfolgt nur für das Objekt, dessen signalisierter Zustand die Wartebedingung erfüllt hat. Beispielsweise wird die Anzahl eines Semaphors um eins verringert.

Versionsinformationen

Ab .NET Framework Version 2.0 wird der Thread.CurrentPrincipal Eigenschaftswert an Workerthreads weitergegeben, die mithilfe der -Methode in die RegisterWaitForSingleObject Warteschlange gestellt werden. In früheren Versionen werden die Prinzipalinformationen nicht weitergegeben.

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 von dieser Methode zurückgegebene Methode verwendet haben, rufen Sie deren RegisteredWaitHandle.Unregister Methode auf, um Verweise auf das Wartehandle freizugeben. Es wird empfohlen, die RegisteredWaitHandle.Unregister -Methode immer aufzurufen, auch wenn Sie für executeOnlyOnceangebentrue. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister Methode aufrufen, anstatt vom Finalizer des registrierten Wartehandles abhängig zu sein.

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

  • Das angegebene Objekt befindet sich im signalierten Zustand.

  • Das Timeoutintervall verstreicht.

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

Wichtig

Die Verwendung eines Mutex für waitObject bietet keinen gegenseitigen Ausschluss für die Rückrufe, da die zugrunde liegende Windows-API das Standardflag WT_EXECUTEDEFAULT verwendet, sodass jeder Rückruf für einen separaten Threadpoolthread gesendet wird. Verwenden Sie anstelle eines Mutexeine Semaphore mit einer maximalen Anzahl von 1.

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

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

Vor der Rückgabe ändert die Funktion den Zustand einiger Typen von Synchronisierungsobjekten. Die Änderung erfolgt nur für das Objekt, dessen signalisierter Zustand die Wartebedingung erfüllt hat. Beispielsweise wird die Anzahl eines Semaphors um eins verringert.

Versionsinformationen

Ab .NET Framework Version 2.0 wird der Thread.CurrentPrincipal Eigenschaftswert an Workerthreads weitergegeben, die mithilfe der -Methode in die RegisterWaitForSingleObject Warteschlange gestellt werden. In früheren Versionen werden die Prinzipalinformationen nicht weitergegeben.

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 von dieser Methode zurückgegebene Methode verwendet haben, rufen Sie deren RegisteredWaitHandle.Unregister Methode auf, um Verweise auf das Wartehandle freizugeben. Es wird empfohlen, die RegisteredWaitHandle.Unregister -Methode immer aufzurufen, auch wenn Sie für executeOnlyOnceangebentrue. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister Methode aufrufen, anstatt vom Finalizer des registrierten Wartehandles abhängig zu sein.

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

  • Das angegebene Objekt befindet sich im signalierten Zustand.

  • Das Timeoutintervall verstreicht.

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

Wichtig

Die Verwendung eines Mutex für waitObject bietet keinen gegenseitigen Ausschluss für die Rückrufe, da die zugrunde liegende Windows-API das Standardflag WT_EXECUTEDEFAULT verwendet, sodass jeder Rückruf für einen separaten Threadpoolthread gesendet wird. Verwenden Sie anstelle eines Mutexeine Semaphore mit einer maximalen Anzahl von 1.

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

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

Vor der Rückgabe ändert die Funktion den Zustand einiger Typen von Synchronisierungsobjekten. Die Änderung erfolgt nur für das Objekt, dessen signalisierter Zustand die Wartebedingung erfüllt hat. Beispielsweise wird die Anzahl eines Semaphors um eins verringert.

Versionsinformationen

Ab .NET Framework Version 2.0 wird der Thread.CurrentPrincipal Eigenschaftswert an Workerthreads weitergegeben, die mithilfe der -Methode in die RegisterWaitForSingleObject Warteschlange gestellt werden. In früheren Versionen werden die Prinzipalinformationen nicht weitergegeben.

Siehe auch

Gilt für