ThreadPool.RegisterWaitForSingleObject Metoda

Definicja

Rejestruje delegata, który oczekuje na element WaitHandle.

Przeciążenia

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

Rejestruje delegata do oczekiwania na WaitHandlewartość , określając 32-bitową liczbę całkowitą bez znaku dla limitu czasu w milisekundach.

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

Rejestruje delegata do oczekiwania na WaitHandlewartość , określając TimeSpan wartość limitu czasu.

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

Rejestruje delegata do oczekiwania na WaitHandlewartość , określając 32-bitową liczbę całkowitą ze znakiem limitu czasu w milisekundach.

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

Rejestruje delegata do oczekiwania na WaitHandlewartość , określając 64-bitową liczbę całkowitą podpisaną dla limitu czasu w milisekundach.

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

Źródło:
ThreadPoolWorkQueue.cs
Źródło:
ThreadPoolWorkQueue.cs
Źródło:
ThreadPoolWorkQueue.cs

Ważne

Ten interfejs API nie jest zgodny ze specyfikacją CLS.

Rejestruje delegata do oczekiwania na WaitHandlewartość , określając 32-bitową liczbę całkowitą bez znaku dla limitu czasu w milisekundach.

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

Parametry

waitObject
WaitHandle

Identyfikator do zarejestrowania WaitHandle . Użyj innego WaitHandle niż Mutex.

callBack
WaitOrTimerCallback

Delegat WaitOrTimerCallback do wywołania, gdy waitObject parametr jest zasygnalizowany.

state
Object

Obiekt przekazany do delegata.

millisecondsTimeOutInterval
UInt32

Limit czasu w milisekundach. millisecondsTimeOutInterval Jeśli parametr ma wartość 0 (zero), funkcja sprawdza stan obiektu i zwraca natychmiast. Jeśli millisecondsTimeOutInterval wartość to -1, interwał limitu czasu funkcji nigdy nie upłynął.

executeOnlyOnce
Boolean

true aby wskazać, że wątek nie będzie już czekać na waitObject parametr po wywołaniu delegata; false aby wskazać, że czasomierz jest resetowany za każdym razem, gdy operacja oczekiwania zakończy się aż do wyrejestrowania oczekiwania.

Zwraca

Może RegisteredWaitHandle służyć do anulowania zarejestrowanej operacji oczekiwania.

Atrybuty

Wyjątki

Parametr millisecondsTimeOutInterval jest mniejszy niż -1.

Przykłady

W poniższym przykładzie pokazano, jak za pomocą RegisterWaitForSingleObject metody wykonać określoną metodę wywołania zwrotnego, gdy zostanie zasygnalizowana określona dojście oczekiwania. W tym przykładzie metoda wywołania zwrotnego to WaitProc, a uchwyt oczekiwania to AutoResetEvent.

W przykładzie zdefiniowano klasę TaskInfo do przechowywania informacji przekazywanych do wywołania zwrotnego podczas wykonywania. Przykład tworzy TaskInfo obiekt i przypisuje mu dane ciągów. Metoda RegisteredWaitHandle zwracana przez RegisterWaitForSingleObject metodę jest przypisywana do Handle pola TaskInfo obiektu, aby metoda wywołania zwrotnego ma dostęp do RegisteredWaitHandleobiektu .

Oprócz określenia TaskInfo jako obiektu, który ma być przekazywany do metody wywołania zwrotnego, wywołanie RegisterWaitForSingleObject metody określaAutoResetEvent, że WaitProc zadanie będzie czekać, WaitOrTimerCallback delegat reprezentujący metodę wywołania zwrotnego, jeden drugi interwał limitu czasu i wiele wywołań zwrotnych.

Gdy główny wątek sygnalizuje AutoResetEvent metodę , Set jest wywoływany WaitOrTimerCallback delegat. Metoda WaitProc testuje RegisteredWaitHandle , aby określić, czy wystąpił limit czasu. Jeśli wywołanie zwrotne zostało wywołane, ponieważ zasygnalizowano obsługę oczekiwania, WaitProc metoda wyrejestrowuje metodę RegisteredWaitHandle, zatrzymując dodatkowe wywołania zwrotne. W przypadku przekroczenia limitu czasu zadanie będzie nadal czekać. Metoda WaitProc kończy się drukowaniem komunikatu do konsoli.

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

Uwagi

Po zakończeniu RegisteredWaitHandle korzystania z metody zwracanej przez tę metodę wywołaj metodę , RegisteredWaitHandle.Unregister aby zwolnić odwołania do uchwytu oczekiwania. Zalecamy, aby zawsze wywoływać metodę RegisteredWaitHandle.Unregister , nawet jeśli określono true wartość executeOnlyOnce. Odzyskiwanie pamięci działa wydajniej, jeśli wywołasz metodę RegisteredWaitHandle.Unregister zamiast w zależności od finalizatora zarejestrowanego uchwytu oczekiwania.

Metoda RegisterWaitForSingleObject kolejkuje określonego delegata do puli wątków. Wątek procesu roboczego wykona delegata, gdy wystąpi jeden z następujących:

  • Określony obiekt jest w stanie sygnału.
  • Interwał limitu czasu upłynął.

Metoda RegisterWaitForSingleObject sprawdza bieżący stan określonego obiektu WaitHandle. Jeśli stan obiektu jest niepodpisany, metoda rejestruje operację oczekiwania. Operacja oczekiwania jest wykonywana przez wątek z puli wątków. Delegat jest wykonywany przez wątek procesu roboczego, gdy stan obiektu zostanie zasygnalizowany lub upłynął interwał przekroczenia limitu czasu. timeOutInterval Jeśli parametr nie ma wartości 0 (zero), a executeOnlyOnce parametr to false, czasomierz jest resetowany za każdym razem, gdy zdarzenie zostanie zasygnalizowane lub upłynął interwał limitu czasu.

Ważne

Użycie elementu Mutex for waitObject nie zapewnia wzajemnego wykluczenia wywołań zwrotnych, ponieważ podstawowy interfejs API systemu Windows używa flagi domyślnej WT_EXECUTEDEFAULT , więc każde wywołanie zwrotne jest wysyłane w osobnym wątku puli wątków. MutexZamiast , użyj wartości Semaphore z maksymalną liczbą 1.

Aby anulować operację oczekiwania, wywołaj metodę RegisteredWaitHandle.Unregister .

Wątek oczekiwania używa funkcji Win32 WaitForMultipleObjects do monitorowania zarejestrowanych operacji oczekiwania. W związku z tym, jeśli musisz użyć tego samego natywnego uchwytu systemu operacyjnego w wielu wywołaniach do RegisterWaitForSingleObjectprogramu , należy zduplikować uchwyt przy użyciu funkcji Win32 DuplicateHandle . Należy pamiętać, że nie należy impulsować obiektu zdarzenia przekazanego do RegisterWaitForSingleObjectelementu , ponieważ wątek oczekiwania może nie wykryć, że zdarzenie jest sygnalizowane przed zresetowaniem.

Przed zwróceniem funkcja modyfikuje stan niektórych typów obiektów synchronizacji. Modyfikacja występuje tylko dla obiektu, którego stan zasygnalizowany spowodował spełnienie warunku oczekiwania. Na przykład liczba semaforów jest zmniejszana o jedną.

Zobacz też

Dotyczy

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

Źródło:
ThreadPoolWorkQueue.cs
Źródło:
ThreadPoolWorkQueue.cs
Źródło:
ThreadPoolWorkQueue.cs

Rejestruje delegata do oczekiwania na WaitHandlewartość , określając TimeSpan wartość limitu czasu.

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

Parametry

waitObject
WaitHandle

Identyfikator do zarejestrowania WaitHandle . Użyj innego WaitHandle niż Mutex.

callBack
WaitOrTimerCallback

Delegat WaitOrTimerCallback do wywołania, gdy waitObject parametr jest zasygnalizowany.

state
Object

Obiekt przekazany do delegata.

timeout
TimeSpan

Limit czasu reprezentowany przez element TimeSpan. Jeśli timeout wartość to 0 (zero), funkcja sprawdza stan obiektu i zwraca natychmiast. Jeśli timeout wartość to -1, interwał limitu czasu funkcji nigdy nie upłynął.

executeOnlyOnce
Boolean

true aby wskazać, że wątek nie będzie już czekać na waitObject parametr po wywołaniu delegata; false aby wskazać, że czasomierz jest resetowany za każdym razem, gdy operacja oczekiwania zakończy się aż do wyrejestrowania oczekiwania.

Zwraca

Hermetyzuje RegisteredWaitHandle uchwyt macierzysty.

Atrybuty

Wyjątki

Parametr timeout jest mniejszy niż -1.

Parametr timeout jest większy niż Int32.MaxValue.

Uwagi

Po zakończeniu RegisteredWaitHandle korzystania z metody zwracanej przez tę metodę wywołaj metodę , RegisteredWaitHandle.Unregister aby zwolnić odwołania do uchwytu oczekiwania. Zalecamy, aby zawsze wywoływać metodę RegisteredWaitHandle.Unregister , nawet jeśli określono true wartość executeOnlyOnce. Odzyskiwanie pamięci działa wydajniej, jeśli wywołasz metodę RegisteredWaitHandle.Unregister zamiast w zależności od finalizatora zarejestrowanego uchwytu oczekiwania.

Metoda RegisterWaitForSingleObject kolejkuje określonego delegata do puli wątków. Wątek procesu roboczego wykona delegata, gdy wystąpi jeden z następujących:

  • Określony obiekt jest w stanie sygnału.
  • Interwał limitu czasu upłynął.

Metoda RegisterWaitForSingleObject sprawdza bieżący stan określonego obiektu WaitHandle. Jeśli stan obiektu jest niepodpisany, metoda rejestruje operację oczekiwania. Operacja oczekiwania jest wykonywana przez wątek z puli wątków. Delegat jest wykonywany przez wątek procesu roboczego, gdy stan obiektu zostanie zasygnalizowany lub upłynął interwał przekroczenia limitu czasu. timeOutInterval Jeśli parametr nie ma wartości 0 (zero), a executeOnlyOnce parametr to false, czasomierz jest resetowany za każdym razem, gdy zdarzenie zostanie zasygnalizowane lub upłynął interwał limitu czasu.

Ważne

Użycie elementu Mutex for waitObject nie zapewnia wzajemnego wykluczenia wywołań zwrotnych, ponieważ podstawowy interfejs API systemu Windows używa flagi domyślnej WT_EXECUTEDEFAULT , więc każde wywołanie zwrotne jest wysyłane w osobnym wątku puli wątków. MutexZamiast , użyj wartości Semaphore z maksymalną liczbą 1.

Aby anulować operację oczekiwania, wywołaj metodę RegisteredWaitHandle.Unregister .

Wątek oczekiwania używa funkcji Win32 WaitForMultipleObjects do monitorowania zarejestrowanych operacji oczekiwania. W związku z tym, jeśli musisz użyć tego samego natywnego uchwytu systemu operacyjnego w wielu wywołaniach do RegisterWaitForSingleObjectprogramu , należy zduplikować uchwyt przy użyciu funkcji Win32 DuplicateHandle . Należy pamiętać, że nie należy impulsować obiektu zdarzenia przekazanego do RegisterWaitForSingleObjectelementu , ponieważ wątek oczekiwania może nie wykryć, że zdarzenie jest sygnalizowane przed zresetowaniem.

Przed zwróceniem funkcja modyfikuje stan niektórych typów obiektów synchronizacji. Modyfikacja występuje tylko dla obiektu, którego stan zasygnalizowany spowodował spełnienie warunku oczekiwania. Na przykład liczba semaforów jest zmniejszana o jedną.

Zobacz też

Dotyczy

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

Źródło:
ThreadPoolWorkQueue.cs
Źródło:
ThreadPoolWorkQueue.cs
Źródło:
ThreadPoolWorkQueue.cs

Rejestruje delegata do oczekiwania na WaitHandlewartość , określając 32-bitową liczbę całkowitą ze znakiem limitu czasu w milisekundach.

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

Parametry

waitObject
WaitHandle

Identyfikator do zarejestrowania WaitHandle . Użyj innego WaitHandle niż Mutex.

callBack
WaitOrTimerCallback

Delegat WaitOrTimerCallback do wywołania, gdy waitObject parametr jest zasygnalizowany.

state
Object

Obiekt przekazany do delegata.

millisecondsTimeOutInterval
Int32

Limit czasu w milisekundach. millisecondsTimeOutInterval Jeśli parametr ma wartość 0 (zero), funkcja sprawdza stan obiektu i zwraca natychmiast. Jeśli millisecondsTimeOutInterval wartość to -1, interwał limitu czasu funkcji nigdy nie upłynął.

executeOnlyOnce
Boolean

true aby wskazać, że wątek nie będzie już czekać na waitObject parametr po wywołaniu delegata; false aby wskazać, że czasomierz jest resetowany za każdym razem, gdy operacja oczekiwania zakończy się aż do wyrejestrowania oczekiwania.

Zwraca

Hermetyzuje RegisteredWaitHandle uchwyt macierzysty.

Atrybuty

Wyjątki

Parametr millisecondsTimeOutInterval jest mniejszy niż -1.

Uwagi

Po zakończeniu RegisteredWaitHandle korzystania z metody zwracanej przez tę metodę wywołaj metodę , RegisteredWaitHandle.Unregister aby zwolnić odwołania do uchwytu oczekiwania. Zalecamy, aby zawsze wywoływać metodę RegisteredWaitHandle.Unregister , nawet jeśli określono true wartość executeOnlyOnce. Odzyskiwanie pamięci działa wydajniej, jeśli wywołasz metodę RegisteredWaitHandle.Unregister zamiast w zależności od finalizatora zarejestrowanego uchwytu oczekiwania.

Metoda RegisterWaitForSingleObject kolejkuje określonego delegata do puli wątków. Wątek procesu roboczego wykona delegata, gdy wystąpi jeden z następujących:

  • Określony obiekt jest w stanie sygnału.
  • Interwał limitu czasu upłynął.

Metoda RegisterWaitForSingleObject sprawdza bieżący stan określonego obiektu WaitHandle. Jeśli stan obiektu jest niepodpisany, metoda rejestruje operację oczekiwania. Operacja oczekiwania jest wykonywana przez wątek z puli wątków. Delegat jest wykonywany przez wątek procesu roboczego, gdy stan obiektu zostanie zasygnalizowany lub upłynął interwał przekroczenia limitu czasu. timeOutInterval Jeśli parametr nie ma wartości 0 (zero), a executeOnlyOnce parametr to false, czasomierz jest resetowany za każdym razem, gdy zdarzenie zostanie zasygnalizowane lub upłynął interwał limitu czasu.

Ważne

Użycie elementu Mutex for waitObject nie zapewnia wzajemnego wykluczenia wywołań zwrotnych, ponieważ podstawowy interfejs API systemu Windows używa flagi domyślnej WT_EXECUTEDEFAULT , więc każde wywołanie zwrotne jest wysyłane w osobnym wątku puli wątków. MutexZamiast , użyj wartości Semaphore z maksymalną liczbą 1.

Aby anulować operację oczekiwania, wywołaj metodę RegisteredWaitHandle.Unregister .

Wątek oczekiwania używa funkcji Win32 WaitForMultipleObjects do monitorowania zarejestrowanych operacji oczekiwania. W związku z tym, jeśli musisz użyć tego samego natywnego uchwytu systemu operacyjnego w wielu wywołaniach do RegisterWaitForSingleObjectprogramu , należy zduplikować uchwyt przy użyciu funkcji Win32 DuplicateHandle . Należy pamiętać, że nie należy impulsować obiektu zdarzenia przekazanego do RegisterWaitForSingleObjectelementu , ponieważ wątek oczekiwania może nie wykryć, że zdarzenie jest sygnalizowane przed zresetowaniem.

Przed zwróceniem funkcja modyfikuje stan niektórych typów obiektów synchronizacji. Modyfikacja występuje tylko dla obiektu, którego stan zasygnalizowany spowodował spełnienie warunku oczekiwania. Na przykład liczba semaforów jest zmniejszana o jedną.

Zobacz też

Dotyczy

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

Źródło:
ThreadPoolWorkQueue.cs
Źródło:
ThreadPoolWorkQueue.cs
Źródło:
ThreadPoolWorkQueue.cs

Rejestruje delegata do oczekiwania na WaitHandlewartość , określając 64-bitową liczbę całkowitą podpisaną dla limitu czasu w milisekundach.

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

Parametry

waitObject
WaitHandle

Identyfikator do zarejestrowania WaitHandle . Użyj innego WaitHandle niż Mutex.

callBack
WaitOrTimerCallback

Delegat WaitOrTimerCallback do wywołania, gdy waitObject parametr jest zasygnalizowany.

state
Object

Obiekt przekazany do delegata.

millisecondsTimeOutInterval
Int64

Limit czasu w milisekundach. millisecondsTimeOutInterval Jeśli parametr ma wartość 0 (zero), funkcja sprawdza stan obiektu i zwraca natychmiast. Jeśli millisecondsTimeOutInterval wartość to -1, interwał limitu czasu funkcji nigdy nie upłynął.

executeOnlyOnce
Boolean

true aby wskazać, że wątek nie będzie już czekać na waitObject parametr po wywołaniu delegata; false aby wskazać, że czasomierz jest resetowany za każdym razem, gdy operacja oczekiwania zakończy się aż do wyrejestrowania oczekiwania.

Zwraca

Hermetyzuje RegisteredWaitHandle uchwyt macierzysty.

Atrybuty

Wyjątki

Parametr millisecondsTimeOutInterval jest mniejszy niż -1.

Uwagi

Po zakończeniu RegisteredWaitHandle korzystania z metody zwracanej przez tę metodę wywołaj metodę , RegisteredWaitHandle.Unregister aby zwolnić odwołania do uchwytu oczekiwania. Zalecamy, aby zawsze wywoływać metodę RegisteredWaitHandle.Unregister , nawet jeśli określono true wartość executeOnlyOnce. Odzyskiwanie pamięci działa wydajniej, jeśli wywołasz metodę RegisteredWaitHandle.Unregister zamiast w zależności od finalizatora zarejestrowanego uchwytu oczekiwania.

Metoda RegisterWaitForSingleObject kolejkuje określonego delegata do puli wątków. Wątek procesu roboczego wykona delegata, gdy wystąpi jeden z następujących:

  • Określony obiekt jest w stanie sygnału.
  • Interwał limitu czasu upłynął.

Metoda RegisterWaitForSingleObject sprawdza bieżący stan określonego obiektu WaitHandle. Jeśli stan obiektu jest niepodpisany, metoda rejestruje operację oczekiwania. Operacja oczekiwania jest wykonywana przez wątek z puli wątków. Delegat jest wykonywany przez wątek procesu roboczego, gdy stan obiektu zostanie zasygnalizowany lub upłynął interwał przekroczenia limitu czasu. timeOutInterval Jeśli parametr nie ma wartości 0 (zero), a executeOnlyOnce parametr to false, czasomierz jest resetowany za każdym razem, gdy zdarzenie zostanie zasygnalizowane lub upłynął interwał limitu czasu.

Ważne

Użycie elementu Mutex for waitObject nie zapewnia wzajemnego wykluczenia wywołań zwrotnych, ponieważ podstawowy interfejs API systemu Windows używa flagi domyślnej WT_EXECUTEDEFAULT , więc każde wywołanie zwrotne jest wysyłane w osobnym wątku puli wątków. MutexZamiast , użyj wartości Semaphore z maksymalną liczbą 1.

Aby anulować operację oczekiwania, wywołaj metodę RegisteredWaitHandle.Unregister .

Wątek oczekiwania używa funkcji Win32 WaitForMultipleObjects do monitorowania zarejestrowanych operacji oczekiwania. W związku z tym, jeśli musisz użyć tego samego natywnego uchwytu systemu operacyjnego w wielu wywołaniach do RegisterWaitForSingleObjectprogramu , należy zduplikować uchwyt przy użyciu funkcji Win32 DuplicateHandle . Należy pamiętać, że nie należy impulsować obiektu zdarzenia przekazanego do RegisterWaitForSingleObjectelementu , ponieważ wątek oczekiwania może nie wykryć, że zdarzenie jest sygnalizowane przed zresetowaniem.

Przed zwróceniem funkcja modyfikuje stan niektórych typów obiektów synchronizacji. Modyfikacja występuje tylko dla obiektu, którego stan zasygnalizowany spowodował spełnienie warunku oczekiwania. Na przykład liczba semaforów jest zmniejszana o jedną.

Zobacz też

Dotyczy