ThreadPool.RegisterWaitForSingleObject Метод

Определение

Регистрирует делегат, ожидающий объект WaitHandle.Registers a delegate that is waiting for a WaitHandle.

Перегрузки

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

Регистрирует делегат для ожидания объекта WaitHandle, задавая время ожидания в миллисекундах в виде 32-разрядного целого числа без знака.Registers a delegate to wait for a WaitHandle, specifying a 32-bit unsigned integer for the time-out in milliseconds.

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

Регистрирует делегат для ожидания объекта WaitHandle, задавая значение TimeSpan для времени ожидания.Registers a delegate to wait for a WaitHandle, specifying a TimeSpan value for the time-out.

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

Регистрирует делегат для ожидания объекта WaitHandle, задавая время ожидания в миллисекундах в виде 32-разрядного целого числа со знаком.Registers a delegate to wait for a WaitHandle, specifying a 32-bit signed integer for the time-out in milliseconds.

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

Регистрирует делегат для ожидания объекта WaitHandle, задавая время ожидания в миллисекундах в виде 64-разрядного целого числа со знаком.Registers a delegate to wait for a WaitHandle, specifying a 64-bit signed integer for the time-out in milliseconds.

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

Важно!

Этот API несовместим с CLS.

Регистрирует делегат для ожидания объекта WaitHandle, задавая время ожидания в миллисекундах в виде 32-разрядного целого числа без знака.Registers a delegate to wait for a WaitHandle, specifying a 32-bit unsigned integer for the time-out in milliseconds.

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, System::UInt32 millisecondsTimeOutInterval, bool executeOnlyOnce);
[System.CLSCompliant(false)]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, uint millisecondsTimeOutInterval, bool executeOnlyOnce);
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

Параметры

waitObject
WaitHandle

Регистрируемый объект WaitHandle.The WaitHandle to register. Используйте объект WaitHandle, отличный от Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Делегат WaitOrTimerCallback, который вызывается при получении сигнала объектом, указанным в параметре waitObject.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Передаваемый делегату объект.The object passed to the delegate.

millisecondsTimeOutInterval
UInt32

Время ожидания в миллисекундах.The time-out in milliseconds. Если параметр millisecondsTimeOutInterval равен 0 (нулю), функция проверяет состояние объекта и немедленно возвращает значение.If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Если параметр millisecondsTimeOutInterval равен -1, время ожидания функции никогда не истекает.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

Значение true указывает, что после вызова делегата поток не будет ожидать параметр waitObject; значение false указывает, что таймер сбрасывается всякий раз по завершении операции ожидания до тех пор, пока регистрация ожидания не будет отменена.true to indicate that the thread will no longer wait on the waitObject parameter after the delegate has been called; false to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.

Возвраты

Объект RegisteredWaitHandle, который можно использовать для отмены зарегистрированной операции ожидания.The RegisteredWaitHandle that can be used to cancel the registered wait operation.

Атрибуты

Исключения

Значение параметра millisecondsTimeOutInterval меньше –1.The millisecondsTimeOutInterval parameter is less than -1.

Примеры

В следующем примере показано, как использовать метод RegisterWaitForSingleObject для выполнения указанного метода обратного вызова при сигнале указанного дескриптора ожидания.The following example shows how to use the RegisterWaitForSingleObject method to execute a specified callback method when a specified wait handle is signaled. В этом примере метод обратного вызова имеет значение WaitProc, а маркер ожидания — AutoResetEvent.In this example, the callback method is WaitProc, and the wait handle is an AutoResetEvent.

В примере определяется класс TaskInfo, в котором хранятся сведения, передаваемые обратному вызову при его выполнении.The example defines a TaskInfo class to hold the information that is passed to the callback when it executes. В примере создается объект TaskInfo и назначается часть строковых данных.The example creates a TaskInfo object and assigns it some string data. @No__t-0, возвращаемый методом RegisterWaitForSingleObject, присваивается полю Handle объекта TaskInfo, чтобы метод обратного вызова получил доступ к RegisteredWaitHandle.The RegisteredWaitHandle that is returned by the RegisterWaitForSingleObject method is assigned to the Handle field of the TaskInfo object so that the callback method has access to the RegisteredWaitHandle.

Помимо указания TaskInfo в качестве объекта для передачи в метод обратного вызова, вызов метода RegisterWaitForSingleObject указывает AutoResetEvent, который будет ожидать задача, делегат WaitOrTimerCallback, представляющий метод обратного вызова WaitProc, один второй интервал времени ожидания. и несколько обратных вызовов.In addition to specifying TaskInfo as the object to pass to the callback method, the call to the RegisterWaitForSingleObject method specifies the AutoResetEvent that the task will wait for, a WaitOrTimerCallback delegate that represents the WaitProc callback method, a one second time-out interval, and multiple callbacks.

Когда главный поток передает AutoResetEvent, вызывая метод Set, вызывается делегат WaitOrTimerCallback.When the main thread signals the AutoResetEvent by calling its Set method, the WaitOrTimerCallback delegate is invoked. Метод WaitProc проверяет RegisteredWaitHandle, чтобы определить, было ли истекло время ожидания.The WaitProc method tests RegisteredWaitHandle to determine whether a time-out occurred. Если обратный вызов был вызван из-за того, что дескриптор ожидания был сигнальным, метод WaitProc отменяет регистрацию RegisteredWaitHandle и останавливает дополнительные обратные вызовы.If the callback was invoked because the wait handle was signaled, the WaitProc method unregisters the RegisteredWaitHandle, stopping additional callbacks. В случае истечения времени ожидания задача будет продолжать ожидание.In the case of a time-out, the task continues to wait. Метод WaitProc завершается печатьм сообщения на консоль.The WaitProc method ends by printing a message to the console.

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

Комментарии

По завершении использования RegisteredWaitHandle, возвращаемого этим методом, вызовите его метод RegisteredWaitHandle.Unregister, чтобы освободить ссылки на маркер ожидания.When you are finished using the RegisteredWaitHandle that is returned by this method, call its RegisteredWaitHandle.Unregister method to release references to the wait handle. Рекомендуется всегда вызывать метод RegisteredWaitHandle.Unregister, даже если для executeOnlyOnce задано значение true.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. Сборка мусора более эффективна при вызове метода RegisteredWaitHandle.Unregister, а не в зависимости от метода завершения зарегистрированного обработчика ожидания.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

Метод RegisterWaitForSingleObject помещает указанный делегат в очередь пула потоков.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Рабочий поток будет выполнять делегат при возникновении одного из следующих событий:A worker thread will execute the delegate when one of the following occurs:

  • Указанный объект находится в сигнальном состоянии.The specified object is in the signaled state.

  • Интервал времени ожидания истекает.The time-out interval elapses.

Метод RegisterWaitForSingleObject проверяет текущее состояние указанного объекта WaitHandle.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Если состояние объекта не сигнальо, метод регистрирует операцию ожидания.If the object's state is unsignaled, the method registers a wait operation. Операция ожидания выполняется потоком из пула потоков.The wait operation is performed by a thread from the thread pool. Делегат выполняется рабочим потоком, когда состояние объекта становится сигнальным или истекает интервал времени ожидания.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Если параметр timeOutInterval не равен 0 (нулю), а параметр executeOnlyOncefalse, таймер сбрасывается каждый раз, когда событие получает сигнал, или истекает интервал времени ожидания.If the timeOutInterval parameter is not 0 (zero) and the executeOnlyOnce parameter is false, the timer is reset every time the event is signaled or the time-out interval elapses.

Важно!

Использование Mutex для waitObject не обеспечивает взаимного исключения для обратных вызовов, так как базовый API Windows использует флаг по умолчанию WT_EXECUTEDEFAULT, поэтому каждый обратный вызов отправляется в отдельный поток пула потоков.Using a Mutex for waitObject does not provide mutual exclusion for the callbacks because the underlying Windows API uses the default WT_EXECUTEDEFAULT flag, so each callback is dispatched on a separate thread pool thread. Вместо Mutex используйте Semaphore с максимальным значением счетчика, равным 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Чтобы отменить операцию ожидания, вызовите метод RegisteredWaitHandle.Unregister.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Поток ожидания использует функцию Win32 WaitForMultipleObjects для отслеживания зарегистрированных операций ожидания.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Поэтому, если необходимо использовать один и тот же собственный обработчик операционной системы в нескольких вызовах RegisterWaitForSingleObject, необходимо дублировать этот обработчик с помощью функции Win32 DuplicateHandle.Therefore, if you must use the same native operating system handle in multiple calls to RegisterWaitForSingleObject, you must duplicate the handle using the Win32 DuplicateHandle function. Обратите внимание, что объект события, переданный в RegisterWaitForSingleObject, не должен передаваться, так как поток ожидания может не обнаружить, что событие сообщается перед сбросом.Note that you should not pulse an event object passed to RegisterWaitForSingleObject, because the wait thread might not detect that the event is signaled before it is reset.

Перед возвращением функция изменяет состояние некоторых типов объектов синхронизации.Before returning, the function modifies the state of some types of synchronization objects. Изменение происходит только для объекта, сигнальное состояние которого привело к удовлетворению условия ожидания.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Например, количество семафоров уменьшается на единицу.For example, the count of a semaphore is decreased by one.

Сведения о версииVersion Information

Начиная с версии .NET Framework 2,0 значение свойства Thread.CurrentPrincipal распространяется на рабочие потоки, помещенные в очередь с помощью метода RegisterWaitForSingleObject.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. В более ранних версиях сведения о субъекте не распространяются.In earlier versions, the principal information is not propagated.

Дополнительно

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

Регистрирует делегат для ожидания объекта WaitHandle, задавая значение TimeSpan для времени ожидания.Registers a delegate to wait for a WaitHandle, specifying a TimeSpan value for the time-out.

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, TimeSpan timeout, bool executeOnlyOnce);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, TimeSpan timeout, bool executeOnlyOnce);
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * TimeSpan * bool -> System.Threading.RegisteredWaitHandle
Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, timeout As TimeSpan, executeOnlyOnce As Boolean) As RegisteredWaitHandle

Параметры

waitObject
WaitHandle

Регистрируемый объект WaitHandle.The WaitHandle to register. Используйте объект WaitHandle, отличный от Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Делегат WaitOrTimerCallback, который вызывается при получении сигнала объектом, указанным в параметре waitObject.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Передаваемый делегату объект.The object passed to the delegate.

timeout
TimeSpan

Время ожидания, представленное объектом TimeSpan.The time-out represented by a TimeSpan. Если параметр timeout равен 0 (нулю), функция проверяет состояние объекта и немедленно возвращает значение.If timeout is 0 (zero), the function tests the object's state and returns immediately. Если параметр timeout равен -1, время ожидания функции никогда не истекает.If timeout is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

Значение true указывает, что после вызова делегата поток не будет ожидать параметр waitObject; значение false указывает, что таймер сбрасывается всякий раз по завершении операции ожидания до тех пор, пока регистрация ожидания не будет отменена.true to indicate that the thread will no longer wait on the waitObject parameter after the delegate has been called; false to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.

Возвраты

Объект RegisteredWaitHandle, инкапсулирующий собственный дескриптор.The RegisteredWaitHandle that encapsulates the native handle.

Исключения

Значение параметра timeout меньше –1.The timeout parameter is less than -1.

Значение параметра timeout больше значения MaxValue.The timeout parameter is greater than MaxValue.

Комментарии

По завершении использования RegisteredWaitHandle, возвращаемого этим методом, вызовите его метод RegisteredWaitHandle.Unregister, чтобы освободить ссылки на маркер ожидания.When you are finished using the RegisteredWaitHandle that is returned by this method, call its RegisteredWaitHandle.Unregister method to release references to the wait handle. Рекомендуется всегда вызывать метод RegisteredWaitHandle.Unregister, даже если для executeOnlyOnce задано значение true.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. Сборка мусора более эффективна при вызове метода RegisteredWaitHandle.Unregister, а не в зависимости от метода завершения зарегистрированного обработчика ожидания.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

Метод RegisterWaitForSingleObject помещает указанный делегат в очередь пула потоков.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Рабочий поток будет выполнять делегат при возникновении одного из следующих событий:A worker thread will execute the delegate when one of the following occurs:

  • Указанный объект находится в сигнальном состоянии.The specified object is in the signaled state.

  • Интервал времени ожидания истекает.The time-out interval elapses.

Метод RegisterWaitForSingleObject проверяет текущее состояние указанного объекта WaitHandle.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Если состояние объекта не сигнальо, метод регистрирует операцию ожидания.If the object's state is unsignaled, the method registers a wait operation. Операция ожидания выполняется потоком из пула потоков.The wait operation is performed by a thread from the thread pool. Делегат выполняется рабочим потоком, когда состояние объекта становится сигнальным или истекает интервал времени ожидания.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Если параметр timeOutInterval не равен 0 (нулю), а параметр executeOnlyOncefalse, таймер сбрасывается каждый раз, когда событие получает сигнал, или истекает интервал времени ожидания.If the timeOutInterval parameter is not 0 (zero) and the executeOnlyOnce parameter is false, the timer is reset every time the event is signaled or the time-out interval elapses.

Важно!

Использование Mutex для waitObject не обеспечивает взаимного исключения для обратных вызовов, так как базовый API Windows использует флаг по умолчанию WT_EXECUTEDEFAULT, поэтому каждый обратный вызов отправляется в отдельный поток пула потоков.Using a Mutex for waitObject does not provide mutual exclusion for the callbacks because the underlying Windows API uses the default WT_EXECUTEDEFAULT flag, so each callback is dispatched on a separate thread pool thread. Вместо Mutex используйте Semaphore с максимальным значением счетчика, равным 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Чтобы отменить операцию ожидания, вызовите метод RegisteredWaitHandle.Unregister.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Поток ожидания использует функцию Win32 WaitForMultipleObjects для отслеживания зарегистрированных операций ожидания.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Поэтому, если необходимо использовать один и тот же собственный обработчик операционной системы в нескольких вызовах RegisterWaitForSingleObject, необходимо дублировать этот обработчик с помощью функции Win32 DuplicateHandle.Therefore, if you must use the same native operating system handle in multiple calls to RegisterWaitForSingleObject, you must duplicate the handle using the Win32 DuplicateHandle function. Обратите внимание, что объект события, переданный в RegisterWaitForSingleObject, не должен передаваться, так как поток ожидания может не обнаружить, что событие сообщается перед сбросом.Note that you should not pulse an event object passed to RegisterWaitForSingleObject, because the wait thread might not detect that the event is signaled before it is reset.

Перед возвращением функция изменяет состояние некоторых типов объектов синхронизации.Before returning, the function modifies the state of some types of synchronization objects. Изменение происходит только для объекта, сигнальное состояние которого привело к удовлетворению условия ожидания.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Например, количество семафоров уменьшается на единицу.For example, the count of a semaphore is decreased by one.

Сведения о версииVersion Information

Начиная с версии .NET Framework 2,0 значение свойства Thread.CurrentPrincipal распространяется на рабочие потоки, помещенные в очередь с помощью метода RegisterWaitForSingleObject.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. В более ранних версиях сведения о субъекте не распространяются.In earlier versions, the principal information is not propagated.

Дополнительно

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

Регистрирует делегат для ожидания объекта WaitHandle, задавая время ожидания в миллисекундах в виде 32-разрядного целого числа со знаком.Registers a delegate to wait for a WaitHandle, specifying a 32-bit signed integer for the time-out in milliseconds.

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, int millisecondsTimeOutInterval, bool executeOnlyOnce);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, int millisecondsTimeOutInterval, bool executeOnlyOnce);
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * int * bool -> System.Threading.RegisteredWaitHandle
Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, millisecondsTimeOutInterval As Integer, executeOnlyOnce As Boolean) As RegisteredWaitHandle

Параметры

waitObject
WaitHandle

Регистрируемый объект WaitHandle.The WaitHandle to register. Используйте объект WaitHandle, отличный от Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Делегат WaitOrTimerCallback, который вызывается при получении сигнала объектом, указанным в параметре waitObject.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Передаваемый делегату объект.The object that is passed to the delegate.

millisecondsTimeOutInterval
Int32

Время ожидания в миллисекундах.The time-out in milliseconds. Если параметр millisecondsTimeOutInterval равен 0 (нулю), функция проверяет состояние объекта и немедленно возвращает значение.If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Если параметр millisecondsTimeOutInterval равен -1, время ожидания функции никогда не истекает.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

Значение true указывает, что после вызова делегата поток не будет ожидать параметр waitObject; значение false указывает, что таймер сбрасывается всякий раз по завершении операции ожидания до тех пор, пока регистрация ожидания не будет отменена.true to indicate that the thread will no longer wait on the waitObject parameter after the delegate has been called; false to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.

Возвраты

Объект RegisteredWaitHandle, инкапсулирующий собственный дескриптор.The RegisteredWaitHandle that encapsulates the native handle.

Исключения

Значение параметра millisecondsTimeOutInterval меньше –1.The millisecondsTimeOutInterval parameter is less than -1.

Комментарии

По завершении использования RegisteredWaitHandle, возвращаемого этим методом, вызовите его метод RegisteredWaitHandle.Unregister, чтобы освободить ссылки на маркер ожидания.When you are finished using the RegisteredWaitHandle that is returned by this method, call its RegisteredWaitHandle.Unregister method to release references to the wait handle. Рекомендуется всегда вызывать метод RegisteredWaitHandle.Unregister, даже если для executeOnlyOnce задано значение true.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. Сборка мусора более эффективна при вызове метода RegisteredWaitHandle.Unregister, а не в зависимости от метода завершения зарегистрированного обработчика ожидания.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

Метод RegisterWaitForSingleObject помещает указанный делегат в очередь пула потоков.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Рабочий поток будет выполнять делегат при возникновении одного из следующих событий:A worker thread will execute the delegate when one of the following occurs:

  • Указанный объект находится в сигнальном состоянии.The specified object is in the signaled state.

  • Интервал времени ожидания истекает.The time-out interval elapses.

Метод RegisterWaitForSingleObject проверяет текущее состояние указанного объекта WaitHandle.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Если состояние объекта не сигнальо, метод регистрирует операцию ожидания.If the object's state is unsignaled, the method registers a wait operation. Операция ожидания выполняется потоком из пула потоков.The wait operation is performed by a thread from the thread pool. Делегат выполняется рабочим потоком, когда состояние объекта становится сигнальным или истекает интервал времени ожидания.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Если параметр timeOutInterval не равен 0 (нулю), а параметр executeOnlyOncefalse, таймер сбрасывается каждый раз, когда событие получает сигнал, или истекает интервал времени ожидания.If the timeOutInterval parameter is not 0 (zero) and the executeOnlyOnce parameter is false, the timer is reset every time the event is signaled or the time-out interval elapses.

Важно!

Использование Mutex для waitObject не обеспечивает взаимного исключения для обратных вызовов, так как базовый API Windows использует флаг по умолчанию WT_EXECUTEDEFAULT, поэтому каждый обратный вызов отправляется в отдельный поток пула потоков.Using a Mutex for waitObject does not provide mutual exclusion for the callbacks because the underlying Windows API uses the default WT_EXECUTEDEFAULT flag, so each callback is dispatched on a separate thread pool thread. Вместо Mutex используйте Semaphore с максимальным значением счетчика, равным 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Чтобы отменить операцию ожидания, вызовите метод RegisteredWaitHandle.Unregister.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Поток ожидания использует функцию Win32 WaitForMultipleObjects для отслеживания зарегистрированных операций ожидания.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Поэтому, если необходимо использовать один и тот же собственный обработчик операционной системы в нескольких вызовах RegisterWaitForSingleObject, необходимо дублировать этот обработчик с помощью функции Win32 DuplicateHandle.Therefore, if you must use the same native operating system handle in multiple calls to RegisterWaitForSingleObject, you must duplicate the handle using the Win32 DuplicateHandle function. Обратите внимание, что объект события, переданный в RegisterWaitForSingleObject, не должен передаваться, так как поток ожидания может не обнаружить, что событие сообщается перед сбросом.Note that you should not pulse an event object passed to RegisterWaitForSingleObject, because the wait thread might not detect that the event is signaled before it is reset.

Перед возвращением функция изменяет состояние некоторых типов объектов синхронизации.Before returning, the function modifies the state of some types of synchronization objects. Изменение происходит только для объекта, сигнальное состояние которого привело к удовлетворению условия ожидания.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Например, количество семафоров уменьшается на единицу.For example, the count of a semaphore is decreased by one.

Сведения о версииVersion Information

Начиная с версии .NET Framework 2,0 значение свойства Thread.CurrentPrincipal распространяется на рабочие потоки, помещенные в очередь с помощью метода RegisterWaitForSingleObject.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. В более ранних версиях сведения о субъекте не распространяются.In earlier versions, the principal information is not propagated.

Дополнительно

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

Регистрирует делегат для ожидания объекта WaitHandle, задавая время ожидания в миллисекундах в виде 64-разрядного целого числа со знаком.Registers a delegate to wait for a WaitHandle, specifying a 64-bit signed integer for the time-out in milliseconds.

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, long millisecondsTimeOutInterval, bool executeOnlyOnce);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, long millisecondsTimeOutInterval, bool executeOnlyOnce);
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * int64 * bool -> System.Threading.RegisteredWaitHandle
Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, millisecondsTimeOutInterval As Long, executeOnlyOnce As Boolean) As RegisteredWaitHandle

Параметры

waitObject
WaitHandle

Регистрируемый объект WaitHandle.The WaitHandle to register. Используйте объект WaitHandle, отличный от Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Делегат WaitOrTimerCallback, который вызывается при получении сигнала объектом, указанным в параметре waitObject.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Передаваемый делегату объект.The object passed to the delegate.

millisecondsTimeOutInterval
Int64

Время ожидания в миллисекундах.The time-out in milliseconds. Если параметр millisecondsTimeOutInterval равен 0 (нулю), функция проверяет состояние объекта и немедленно возвращает значение.If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Если параметр millisecondsTimeOutInterval равен -1, время ожидания функции никогда не истекает.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

Значение true указывает, что после вызова делегата поток не будет ожидать параметр waitObject; значение false указывает, что таймер сбрасывается всякий раз по завершении операции ожидания до тех пор, пока регистрация ожидания не будет отменена.true to indicate that the thread will no longer wait on the waitObject parameter after the delegate has been called; false to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.

Возвраты

Объект RegisteredWaitHandle, инкапсулирующий собственный дескриптор.The RegisteredWaitHandle that encapsulates the native handle.

Исключения

Значение параметра millisecondsTimeOutInterval меньше –1.The millisecondsTimeOutInterval parameter is less than -1.

Комментарии

По завершении использования RegisteredWaitHandle, возвращаемого этим методом, вызовите его метод RegisteredWaitHandle.Unregister, чтобы освободить ссылки на маркер ожидания.When you are finished using the RegisteredWaitHandle that is returned by this method, call its RegisteredWaitHandle.Unregister method to release references to the wait handle. Рекомендуется всегда вызывать метод RegisteredWaitHandle.Unregister, даже если для executeOnlyOnce задано значение true.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. Сборка мусора более эффективна при вызове метода RegisteredWaitHandle.Unregister, а не в зависимости от метода завершения зарегистрированного обработчика ожидания.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

Метод RegisterWaitForSingleObject помещает указанный делегат в очередь пула потоков.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Рабочий поток будет выполнять делегат при возникновении одного из следующих событий:A worker thread will execute the delegate when one of the following occurs:

  • Указанный объект находится в сигнальном состоянии.The specified object is in the signaled state.

  • Интервал времени ожидания истекает.The time-out interval elapses.

Метод RegisterWaitForSingleObject проверяет текущее состояние указанного объекта WaitHandle.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Если состояние объекта не сигнальо, метод регистрирует операцию ожидания.If the object's state is unsignaled, the method registers a wait operation. Операция ожидания выполняется потоком из пула потоков.The wait operation is performed by a thread from the thread pool. Делегат выполняется рабочим потоком, когда состояние объекта становится сигнальным или истекает интервал времени ожидания.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Если параметр timeOutInterval не равен 0 (нулю), а параметр executeOnlyOncefalse, таймер сбрасывается каждый раз, когда событие получает сигнал, или истекает интервал времени ожидания.If the timeOutInterval parameter is not 0 (zero) and the executeOnlyOnce parameter is false, the timer is reset every time the event is signaled or the time-out interval elapses.

Важно!

Использование Mutex для waitObject не обеспечивает взаимного исключения для обратных вызовов, так как базовый API Windows использует флаг по умолчанию WT_EXECUTEDEFAULT, поэтому каждый обратный вызов отправляется в отдельный поток пула потоков.Using a Mutex for waitObject does not provide mutual exclusion for the callbacks because the underlying Windows API uses the default WT_EXECUTEDEFAULT flag, so each callback is dispatched on a separate thread pool thread. Вместо Mutex используйте Semaphore с максимальным значением счетчика, равным 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Чтобы отменить операцию ожидания, вызовите метод RegisteredWaitHandle.Unregister.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Поток ожидания использует функцию Win32 WaitForMultipleObjects для отслеживания зарегистрированных операций ожидания.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Поэтому, если необходимо использовать один и тот же собственный обработчик операционной системы в нескольких вызовах RegisterWaitForSingleObject, необходимо дублировать этот обработчик с помощью функции Win32 DuplicateHandle.Therefore, if you must use the same native operating system handle in multiple calls to RegisterWaitForSingleObject, you must duplicate the handle using the Win32 DuplicateHandle function. Обратите внимание, что объект события, переданный в RegisterWaitForSingleObject, не должен передаваться, так как поток ожидания может не обнаружить, что событие сообщается перед сбросом.Note that you should not pulse an event object passed to RegisterWaitForSingleObject, because the wait thread might not detect that the event is signaled before it is reset.

Перед возвращением функция изменяет состояние некоторых типов объектов синхронизации.Before returning, the function modifies the state of some types of synchronization objects. Изменение происходит только для объекта, сигнальное состояние которого привело к удовлетворению условия ожидания.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Например, количество семафоров уменьшается на единицу.For example, the count of a semaphore is decreased by one.

Сведения о версииVersion Information

Начиная с версии .NET Framework 2,0 значение свойства Thread.CurrentPrincipal распространяется на рабочие потоки, помещенные в очередь с помощью метода RegisterWaitForSingleObject.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. В более ранних версиях сведения о субъекте не распространяются.In earlier versions, the principal information is not propagated.

Дополнительно

Применяется к