ThreadPool.RegisterWaitForSingleObject Methode

Definitie

Registreert een gemachtigde die wacht op een WaitHandle.

Overloads

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

Registreert een gemachtigde om te wachten op een WaitHandle, waarbij een 32-bits geheel getal zonder teken wordt opgegeven voor de time-out in milliseconden.

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

Registreert een gemachtigde om te wachten op een WaitHandle, waarbij een TimeSpan waarde voor de time-out wordt opgegeven.

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

Registreert een gemachtigde om te wachten op een WaitHandle, waarbij een 32-bits geheel getal wordt opgegeven voor de time-out in milliseconden.

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

Registreert een gemachtigde om te wachten op een WaitHandle, waarbij een 64-bits geheel getal wordt opgegeven voor de time-out in milliseconden.

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

Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs

Belangrijk

Deze API is niet CLS-conform.

Registreert een gemachtigde om te wachten op een WaitHandle, waarbij een 32-bits geheel getal zonder teken wordt opgegeven voor de time-out in milliseconden.

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

Parameters

waitObject
WaitHandle

De WaitHandle te registreren. Gebruik een WaitHandle andere dan Mutex.

callBack
WaitOrTimerCallback

De WaitOrTimerCallback gemachtigde die moet worden aangeroepen wanneer de waitObject parameter wordt gesignaleerd.

state
Object

Het object is doorgegeven aan de gemachtigde.

millisecondsTimeOutInterval
UInt32

De time-out in milliseconden. Als de parameter 0 (nul) millisecondsTimeOutInterval is, test de functie de status van het object en retourneert deze onmiddellijk. Als millisecondsTimeOutInterval -1 is, is het time-outinterval van de functie nooit verstreken.

executeOnlyOnce
Boolean

true om aan te geven dat de thread niet langer op de waitObject parameter wacht nadat de gemachtigde is aangeroepen. false Om aan te geven dat de timer opnieuw wordt ingesteld telkens wanneer de wachtbewerking is voltooid totdat de wachttijd ongedaan is gemaakt.

Retouren

De RegisteredWaitHandle bewerking die kan worden gebruikt om de geregistreerde wachtbewerking te annuleren.

Kenmerken

Uitzonderingen

De millisecondsTimeOutInterval parameter is kleiner dan -1.

Voorbeelden

In het volgende voorbeeld ziet u hoe u de RegisterWaitForSingleObject methode gebruikt om een opgegeven callback-methode uit te voeren wanneer een opgegeven wachtgreep wordt gesignaleerd. In dit voorbeeld is WaitProcde callback-methode en is de wachtgreep een AutoResetEvent.

In het voorbeeld wordt een TaskInfo klasse gedefinieerd voor het opslaan van de informatie die wordt doorgegeven aan de callback wanneer deze wordt uitgevoerd. In het voorbeeld wordt een TaskInfo object gemaakt en worden er tekenreeksgegevens aan toegewezen. Het RegisteredWaitHandle resultaat dat door de RegisterWaitForSingleObject methode wordt geretourneerd, wordt toegewezen aan het Handle veld van het TaskInfo object, zodat de callback-methode toegang heeft tot de RegisteredWaitHandle.

Naast het opgeven TaskInfo als het object dat moet worden doorgegeven aan de callback-methode, geeft de aanroep naar de RegisterWaitForSingleObject methode aan AutoResetEvent dat de taak wacht op, een WaitOrTimerCallback gemachtigde die de WaitProc callback-methode vertegenwoordigt, een time-outinterval van één seconde en meerdere callbacks.

Wanneer de hoofdthread de AutoResetEvent methode aanroept Set , wordt de WaitOrTimerCallback gemachtigde aangeroepen. De WaitProc methode test RegisteredWaitHandle om te bepalen of er een time-out is opgetreden. Als de callback is aangeroepen omdat de wachtgreep is gesignaleerd, wordt de WaitProc registratie van de RegisteredWaitHandlemethode ongedaan maken en worden extra callbacks gestopt. In het geval van een time-out blijft de taak wachten. De WaitProc methode eindigt door een bericht naar de console af te drukken.

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

Opmerkingen

Wanneer u klaar bent met het gebruik van de RegisteredWaitHandle methode die door deze methode wordt geretourneerd, roept u de methode aan RegisteredWaitHandle.Unregister om verwijzingen naar de wachtgreep vrij te geven. U wordt aangeraden altijd de RegisteredWaitHandle.Unregister methode aan te roepen, zelfs als u opgeeft true voor executeOnlyOnce. Garbagecollection werkt efficiënter als u de RegisteredWaitHandle.Unregister methode aanroept in plaats van afhankelijk van de geregistreerde wachtgreep finalizer.

Met RegisterWaitForSingleObject de methode wordt de opgegeven gemachtigde in de wachtrij geplaatst voor de thread-pool. Een werkrolthread voert de gemachtigde uit wanneer een van de volgende situaties plaatsvindt:

  • Het opgegeven object heeft de gesignaleerde status.
  • Het time-outinterval is verstreken.

De RegisterWaitForSingleObject methode controleert de huidige status van het opgegeven object WaitHandle. Als de status van het object niet is ondertekend, registreert de methode een wachtbewerking. De wachtbewerking wordt uitgevoerd door een thread uit de threadpool. De gemachtigde wordt uitgevoerd door een werkrolthread wanneer de status van het object wordt gesignaleerd of het time-outinterval is verstreken. Als de timeOutInterval parameter niet 0 (nul) is en de executeOnlyOnce parameter is false, wordt de timer opnieuw ingesteld telkens wanneer de gebeurtenis wordt gesignaleerd of het time-outinterval is verstreken.

Important

Het gebruik van een Mutex voor waitObject biedt geen wederzijdse uitsluiting voor de callbacks omdat de onderliggende Windows-API gebruikmaakt van de standaardvlag WT_EXECUTEDEFAULT, zodat elke callback wordt verzonden op een afzonderlijke threadgroepthread. Gebruik in plaats van een Mutex, gebruik een Semaphore met een maximumaantal van 1.

Als u de wachtbewerking wilt annuleren, roept u de RegisteredWaitHandle.Unregister methode aan.

De wachtthread gebruikt de Win32-functie WaitForMultipleObjects om geregistreerde wachtbewerkingen te bewaken. Als u daarom dezelfde systeemeigen besturingssysteemgreep in meerdere aanroepen RegisterWaitForSingleObjectmoet gebruiken, moet u de ingang dupliceren met behulp van de Win32-functie DuplicateHandle . Houd er rekening mee dat u geen gebeurtenisobject moet pulsen waarnaar RegisterWaitForSingleObjectwordt doorgegeven, omdat de wachtthread mogelijk niet detecteert dat de gebeurtenis wordt gesignaleerd voordat deze opnieuw wordt ingesteld.

Voordat de functie wordt geretourneerd, wijzigt de functie de status van bepaalde typen synchronisatieobjecten. Wijziging vindt alleen plaats voor het object waarvan de gesignaleerde toestand de wachtvoorwaarde heeft veroorzaakt. Het aantal van een semafore wordt bijvoorbeeld met één afgenomen.

Zie ook

Van toepassing op

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

Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs

Registreert een gemachtigde om te wachten op een WaitHandle, waarbij een TimeSpan waarde voor de time-out wordt opgegeven.

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

Parameters

waitObject
WaitHandle

De WaitHandle te registreren. Gebruik een WaitHandle andere dan Mutex.

callBack
WaitOrTimerCallback

De WaitOrTimerCallback gemachtigde die moet worden aangeroepen wanneer de waitObject parameter wordt gesignaleerd.

state
Object

Het object is doorgegeven aan de gemachtigde.

timeout
TimeSpan

De time-out die wordt vertegenwoordigd door een TimeSpan. Als timeout 0 (nul) is, test de functie de status van het object en retourneert deze onmiddellijk. Als timeout -1 is, is het time-outinterval van de functie nooit verstreken.

executeOnlyOnce
Boolean

true om aan te geven dat de thread niet langer op de waitObject parameter wacht nadat de gemachtigde is aangeroepen. false Om aan te geven dat de timer opnieuw wordt ingesteld telkens wanneer de wachtbewerking is voltooid totdat de wachttijd ongedaan is gemaakt.

Retouren

De RegisteredWaitHandle systeemeigen ingang wordt ingekapseld.

Kenmerken

Uitzonderingen

De timeout parameter is kleiner dan -1.

De timeout parameter is groter dan Int32.MaxValue.

Opmerkingen

Wanneer u klaar bent met het gebruik van de RegisteredWaitHandle methode die door deze methode wordt geretourneerd, roept u de methode aan RegisteredWaitHandle.Unregister om verwijzingen naar de wachtgreep vrij te geven. U wordt aangeraden altijd de RegisteredWaitHandle.Unregister methode aan te roepen, zelfs als u opgeeft true voor executeOnlyOnce. Garbagecollection werkt efficiënter als u de RegisteredWaitHandle.Unregister methode aanroept in plaats van afhankelijk van de geregistreerde wachtgreep finalizer.

Met RegisterWaitForSingleObject de methode wordt de opgegeven gemachtigde in de wachtrij geplaatst voor de thread-pool. Een werkrolthread voert de gemachtigde uit wanneer een van de volgende situaties plaatsvindt:

  • Het opgegeven object heeft de gesignaleerde status.
  • Het time-outinterval is verstreken.

De RegisterWaitForSingleObject methode controleert de huidige status van het opgegeven object WaitHandle. Als de status van het object niet is ondertekend, registreert de methode een wachtbewerking. De wachtbewerking wordt uitgevoerd door een thread uit de threadpool. De gemachtigde wordt uitgevoerd door een werkrolthread wanneer de status van het object wordt gesignaleerd of het time-outinterval is verstreken. Als de timeOutInterval parameter niet 0 (nul) is en de executeOnlyOnce parameter is false, wordt de timer opnieuw ingesteld telkens wanneer de gebeurtenis wordt gesignaleerd of het time-outinterval is verstreken.

Important

Het gebruik van een Mutex voor waitObject biedt geen wederzijdse uitsluiting voor de callbacks omdat de onderliggende Windows-API gebruikmaakt van de standaardvlag WT_EXECUTEDEFAULT, zodat elke callback wordt verzonden op een afzonderlijke threadgroepthread. Gebruik in plaats van een Mutex, gebruik een Semaphore met een maximumaantal van 1.

Als u de wachtbewerking wilt annuleren, roept u de RegisteredWaitHandle.Unregister methode aan.

De wachtthread gebruikt de Win32-functie WaitForMultipleObjects om geregistreerde wachtbewerkingen te bewaken. Als u daarom dezelfde systeemeigen besturingssysteemgreep in meerdere aanroepen RegisterWaitForSingleObjectmoet gebruiken, moet u de ingang dupliceren met behulp van de Win32-functie DuplicateHandle . Houd er rekening mee dat u geen gebeurtenisobject moet pulsen waarnaar RegisterWaitForSingleObjectwordt doorgegeven, omdat de wachtthread mogelijk niet detecteert dat de gebeurtenis wordt gesignaleerd voordat deze opnieuw wordt ingesteld.

Voordat de functie wordt geretourneerd, wijzigt de functie de status van bepaalde typen synchronisatieobjecten. Wijziging vindt alleen plaats voor het object waarvan de gesignaleerde toestand de wachtvoorwaarde heeft veroorzaakt. Het aantal van een semafore wordt bijvoorbeeld met één afgenomen.

Zie ook

Van toepassing op

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

Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs

Registreert een gemachtigde om te wachten op een WaitHandle, waarbij een 32-bits geheel getal wordt opgegeven voor de time-out in milliseconden.

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

Parameters

waitObject
WaitHandle

De WaitHandle te registreren. Gebruik een WaitHandle andere dan Mutex.

callBack
WaitOrTimerCallback

De WaitOrTimerCallback gemachtigde die moet worden aangeroepen wanneer de waitObject parameter wordt gesignaleerd.

state
Object

Het object dat wordt doorgegeven aan de gemachtigde.

millisecondsTimeOutInterval
Int32

De time-out in milliseconden. Als de parameter 0 (nul) millisecondsTimeOutInterval is, test de functie de status van het object en retourneert deze onmiddellijk. Als millisecondsTimeOutInterval -1 is, is het time-outinterval van de functie nooit verstreken.

executeOnlyOnce
Boolean

true om aan te geven dat de thread niet langer op de waitObject parameter wacht nadat de gemachtigde is aangeroepen. false Om aan te geven dat de timer opnieuw wordt ingesteld telkens wanneer de wachtbewerking is voltooid totdat de wachttijd ongedaan is gemaakt.

Retouren

De RegisteredWaitHandle systeemeigen ingang wordt ingekapseld.

Kenmerken

Uitzonderingen

De millisecondsTimeOutInterval parameter is kleiner dan -1.

Opmerkingen

Wanneer u klaar bent met het gebruik van de RegisteredWaitHandle methode die door deze methode wordt geretourneerd, roept u de methode aan RegisteredWaitHandle.Unregister om verwijzingen naar de wachtgreep vrij te geven. U wordt aangeraden altijd de RegisteredWaitHandle.Unregister methode aan te roepen, zelfs als u opgeeft true voor executeOnlyOnce. Garbagecollection werkt efficiënter als u de RegisteredWaitHandle.Unregister methode aanroept in plaats van afhankelijk van de geregistreerde wachtgreep finalizer.

Met RegisterWaitForSingleObject de methode wordt de opgegeven gemachtigde in de wachtrij geplaatst voor de thread-pool. Een werkrolthread voert de gemachtigde uit wanneer een van de volgende situaties plaatsvindt:

  • Het opgegeven object heeft de gesignaleerde status.
  • Het time-outinterval is verstreken.

De RegisterWaitForSingleObject methode controleert de huidige status van het opgegeven object WaitHandle. Als de status van het object niet is ondertekend, registreert de methode een wachtbewerking. De wachtbewerking wordt uitgevoerd door een thread uit de threadpool. De gemachtigde wordt uitgevoerd door een werkrolthread wanneer de status van het object wordt gesignaleerd of het time-outinterval is verstreken. Als de timeOutInterval parameter niet 0 (nul) is en de executeOnlyOnce parameter is false, wordt de timer opnieuw ingesteld telkens wanneer de gebeurtenis wordt gesignaleerd of het time-outinterval is verstreken.

Important

Het gebruik van een Mutex voor waitObject biedt geen wederzijdse uitsluiting voor de callbacks omdat de onderliggende Windows-API gebruikmaakt van de standaardvlag WT_EXECUTEDEFAULT, zodat elke callback wordt verzonden op een afzonderlijke threadgroepthread. Gebruik in plaats van een Mutex, gebruik een Semaphore met een maximumaantal van 1.

Als u de wachtbewerking wilt annuleren, roept u de RegisteredWaitHandle.Unregister methode aan.

De wachtthread gebruikt de Win32-functie WaitForMultipleObjects om geregistreerde wachtbewerkingen te bewaken. Als u daarom dezelfde systeemeigen besturingssysteemgreep in meerdere aanroepen RegisterWaitForSingleObjectmoet gebruiken, moet u de ingang dupliceren met behulp van de Win32-functie DuplicateHandle . Houd er rekening mee dat u geen gebeurtenisobject moet pulsen waarnaar RegisterWaitForSingleObjectwordt doorgegeven, omdat de wachtthread mogelijk niet detecteert dat de gebeurtenis wordt gesignaleerd voordat deze opnieuw wordt ingesteld.

Voordat de functie wordt geretourneerd, wijzigt de functie de status van bepaalde typen synchronisatieobjecten. Wijziging vindt alleen plaats voor het object waarvan de gesignaleerde toestand de wachtvoorwaarde heeft veroorzaakt. Het aantal van een semafore wordt bijvoorbeeld met één afgenomen.

Zie ook

Van toepassing op

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

Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs
Bron:
ThreadPoolWorkQueue.cs

Registreert een gemachtigde om te wachten op een WaitHandle, waarbij een 64-bits geheel getal wordt opgegeven voor de time-out in milliseconden.

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

Parameters

waitObject
WaitHandle

De WaitHandle te registreren. Gebruik een WaitHandle andere dan Mutex.

callBack
WaitOrTimerCallback

De WaitOrTimerCallback gemachtigde die moet worden aangeroepen wanneer de waitObject parameter wordt gesignaleerd.

state
Object

Het object is doorgegeven aan de gemachtigde.

millisecondsTimeOutInterval
Int64

De time-out in milliseconden. Als de parameter 0 (nul) millisecondsTimeOutInterval is, test de functie de status van het object en retourneert deze onmiddellijk. Als millisecondsTimeOutInterval -1 is, is het time-outinterval van de functie nooit verstreken.

executeOnlyOnce
Boolean

true om aan te geven dat de thread niet langer op de waitObject parameter wacht nadat de gemachtigde is aangeroepen. false Om aan te geven dat de timer opnieuw wordt ingesteld telkens wanneer de wachtbewerking is voltooid totdat de wachttijd ongedaan is gemaakt.

Retouren

De RegisteredWaitHandle systeemeigen ingang wordt ingekapseld.

Kenmerken

Uitzonderingen

De millisecondsTimeOutInterval parameter is kleiner dan -1.

Opmerkingen

Wanneer u klaar bent met het gebruik van de RegisteredWaitHandle methode die door deze methode wordt geretourneerd, roept u de methode aan RegisteredWaitHandle.Unregister om verwijzingen naar de wachtgreep vrij te geven. U wordt aangeraden altijd de RegisteredWaitHandle.Unregister methode aan te roepen, zelfs als u opgeeft true voor executeOnlyOnce. Garbagecollection werkt efficiënter als u de RegisteredWaitHandle.Unregister methode aanroept in plaats van afhankelijk van de geregistreerde wachtgreep finalizer.

Met RegisterWaitForSingleObject de methode wordt de opgegeven gemachtigde in de wachtrij geplaatst voor de thread-pool. Een werkrolthread voert de gemachtigde uit wanneer een van de volgende situaties plaatsvindt:

  • Het opgegeven object heeft de gesignaleerde status.
  • Het time-outinterval is verstreken.

De RegisterWaitForSingleObject methode controleert de huidige status van het opgegeven object WaitHandle. Als de status van het object niet is ondertekend, registreert de methode een wachtbewerking. De wachtbewerking wordt uitgevoerd door een thread uit de threadpool. De gemachtigde wordt uitgevoerd door een werkrolthread wanneer de status van het object wordt gesignaleerd of het time-outinterval is verstreken. Als de timeOutInterval parameter niet 0 (nul) is en de executeOnlyOnce parameter is false, wordt de timer opnieuw ingesteld telkens wanneer de gebeurtenis wordt gesignaleerd of het time-outinterval is verstreken.

Important

Het gebruik van een Mutex voor waitObject biedt geen wederzijdse uitsluiting voor de callbacks omdat de onderliggende Windows-API gebruikmaakt van de standaardvlag WT_EXECUTEDEFAULT, zodat elke callback wordt verzonden op een afzonderlijke threadgroepthread. Gebruik in plaats van een Mutex, gebruik een Semaphore met een maximumaantal van 1.

Als u de wachtbewerking wilt annuleren, roept u de RegisteredWaitHandle.Unregister methode aan.

De wachtthread gebruikt de Win32-functie WaitForMultipleObjects om geregistreerde wachtbewerkingen te bewaken. Als u daarom dezelfde systeemeigen besturingssysteemgreep in meerdere aanroepen RegisterWaitForSingleObjectmoet gebruiken, moet u de ingang dupliceren met behulp van de Win32-functie DuplicateHandle . Houd er rekening mee dat u geen gebeurtenisobject moet pulsen waarnaar RegisterWaitForSingleObjectwordt doorgegeven, omdat de wachtthread mogelijk niet detecteert dat de gebeurtenis wordt gesignaleerd voordat deze opnieuw wordt ingesteld.

Voordat de functie wordt geretourneerd, wijzigt de functie de status van bepaalde typen synchronisatieobjecten. Wijziging vindt alleen plaats voor het object waarvan de gesignaleerde toestand de wachtvoorwaarde heeft veroorzaakt. Het aantal van een semafore wordt bijvoorbeeld met één afgenomen.

Zie ook

Van toepassing op