ThreadPool.RegisterWaitForSingleObject Метод

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

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

Параметры

Возвращаемое значение

Можно RegisteredWaitHandle использовать для отмены зарегистрированной операции ожидания.

Атрибуты

CLSCompliantAttribute UnsupportedOSPlatformAttribute

Исключения

Примеры

В следующем примере показано, как использовать RegisterWaitForSingleObject метод для выполнения указанного метода обратного вызова при сигнале заданного дескриптора ожидания. В этом примере метод обратного вызова — WaitProcэто дескриптор AutoResetEventожидания.

В примере определяется TaskInfo класс для хранения сведений, передаваемых обратному вызову при выполнении. В примере создается TaskInfo объект и назначается некоторые строковые данные. Объект RegisteredWaitHandle , возвращаемый методом RegisterWaitForSingleObject , назначается Handle полю объекта, чтобы метод обратного TaskInfo вызова получил доступ к RegisteredWaitHandleобъекту.

Помимо указания TaskInfo в качестве объекта, передаваемого методу обратного вызова, вызов RegisterWaitForSingleObject метода указываетAutoResetEvent, что задача будет ожидать, делегат, представляющий WaitOrTimerCallback метод обратного вызова, WaitProc один второй интервал ожидания и несколько обратных вызовов.

Когда основной поток сигнализирует AutoResetEvent о вызове метода Set , WaitOrTimerCallback вызывается делегат. Метод WaitProc проверяет RegisteredWaitHandle , произошло ли время ожидания. Если обратный вызов был вызван, так как дескриптор ожидания был сигнализован, WaitProc метод отменяет RegisteredWaitHandleрегистрацию дополнительных обратных вызовов. В случае истечения времени ожидания задача продолжает ждать. Метод WaitProc заканчивается печатью сообщения в консоль.

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 метод для выпуска ссылок на дескриптор ожидания. Рекомендуется всегда вызывать RegisteredWaitHandle.Unregister метод, даже если указано true для executeOnlyOnce. Сборка мусора работает более эффективно, если метод вызывается RegisteredWaitHandle.Unregister вместо метода в зависимости от метода завершения зарегистрированного дескриптора ожидания.

Метод RegisterWaitForSingleObject очереди указанного делегата в пул потоков. Рабочий поток будет выполнять делегат, когда происходит одно из следующих действий:

• Указанный объект находится в сигнальном состоянии.
• Интервал ожидания истекает.

Метод RegisterWaitForSingleObject проверяет текущее состояние указанного объекта WaitHandle. Если состояние объекта не указано, метод регистрирует операцию ожидания. Операция ожидания выполняется потоком из пула потоков. Делегат выполняется рабочим потоком, когда состояние объекта становится сигналом или истекает интервал времени ожидания. timeOutInterval Если параметр не равен 0 (ноль) и executeOnlyOnce параметр falseимеет значение, таймер сбрасывается каждый раз, когда событие сигнализирует или истекает интервал времени ожидания.

Чтобы отменить операцию ожидания, вызовите RegisteredWaitHandle.Unregister метод.

Поток ожидания использует функцию Win32 WaitForMultipleObjects для мониторинга зарегистрированных операций ожидания. Таким образом, если необходимо использовать один и тот же собственный дескриптор операционной системы в нескольких вызовах RegisterWaitForSingleObject, необходимо дублировать дескриптор с помощью функции Win32 DuplicateHandle . Обратите внимание, что не следует пульсировать переданный объект RegisterWaitForSingleObjectсобытия, так как поток ожидания может не обнаружить, что событие сигнализируется перед сбросом.

Перед возвратом функция изменяет состояние некоторых типов объектов синхронизации. Изменение происходит только для объекта, сигнальное состояние которого привело к выполнению условия ожидания. Например, количество семафора уменьшается на один.

См. также раздел

• Управляемый пул потоков

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

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

Параметры

Возвращаемое значение

Инкапсулирует RegisteredWaitHandle собственный дескриптор.

Атрибуты

UnsupportedOSPlatformAttribute

Исключения

Комментарии

Завершив использование RegisteredWaitHandle этого метода, вызовите его RegisteredWaitHandle.Unregister метод для выпуска ссылок на дескриптор ожидания. Рекомендуется всегда вызывать RegisteredWaitHandle.Unregister метод, даже если указано true для executeOnlyOnce. Сборка мусора работает более эффективно, если метод вызывается RegisteredWaitHandle.Unregister вместо метода в зависимости от метода завершения зарегистрированного дескриптора ожидания.

Метод RegisterWaitForSingleObject очереди указанного делегата в пул потоков. Рабочий поток будет выполнять делегат, когда происходит одно из следующих действий:

• Указанный объект находится в сигнальном состоянии.
• Интервал ожидания истекает.

Метод RegisterWaitForSingleObject проверяет текущее состояние указанного объекта WaitHandle. Если состояние объекта не указано, метод регистрирует операцию ожидания. Операция ожидания выполняется потоком из пула потоков. Делегат выполняется рабочим потоком, когда состояние объекта становится сигналом или истекает интервал времени ожидания. timeOutInterval Если параметр не равен 0 (ноль) и executeOnlyOnce параметр falseимеет значение, таймер сбрасывается каждый раз, когда событие сигнализирует или истекает интервал времени ожидания.

Чтобы отменить операцию ожидания, вызовите RegisteredWaitHandle.Unregister метод.

Поток ожидания использует функцию Win32 WaitForMultipleObjects для мониторинга зарегистрированных операций ожидания. Таким образом, если необходимо использовать один и тот же собственный дескриптор операционной системы в нескольких вызовах RegisterWaitForSingleObject, необходимо дублировать дескриптор с помощью функции Win32 DuplicateHandle . Обратите внимание, что не следует пульсировать переданный объект RegisterWaitForSingleObjectсобытия, так как поток ожидания может не обнаружить, что событие сигнализируется перед сбросом.

Перед возвратом функция изменяет состояние некоторых типов объектов синхронизации. Изменение происходит только для объекта, сигнальное состояние которого привело к выполнению условия ожидания. Например, количество семафора уменьшается на один.

См. также раздел

• Управляемый пул потоков

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

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

Параметры

Возвращаемое значение

Инкапсулирует RegisteredWaitHandle собственный дескриптор.

Атрибуты

UnsupportedOSPlatformAttribute

Исключения

Комментарии

Завершив использование RegisteredWaitHandle этого метода, вызовите его RegisteredWaitHandle.Unregister метод для выпуска ссылок на дескриптор ожидания. Рекомендуется всегда вызывать RegisteredWaitHandle.Unregister метод, даже если указано true для executeOnlyOnce. Сборка мусора работает более эффективно, если метод вызывается RegisteredWaitHandle.Unregister вместо метода в зависимости от метода завершения зарегистрированного дескриптора ожидания.

Метод RegisterWaitForSingleObject очереди указанного делегата в пул потоков. Рабочий поток будет выполнять делегат, когда происходит одно из следующих действий:

• Указанный объект находится в сигнальном состоянии.
• Интервал ожидания истекает.

Метод RegisterWaitForSingleObject проверяет текущее состояние указанного объекта WaitHandle. Если состояние объекта не указано, метод регистрирует операцию ожидания. Операция ожидания выполняется потоком из пула потоков. Делегат выполняется рабочим потоком, когда состояние объекта становится сигналом или истекает интервал времени ожидания. timeOutInterval Если параметр не равен 0 (ноль) и executeOnlyOnce параметр falseимеет значение, таймер сбрасывается каждый раз, когда событие сигнализирует или истекает интервал времени ожидания.

Чтобы отменить операцию ожидания, вызовите RegisteredWaitHandle.Unregister метод.

Поток ожидания использует функцию Win32 WaitForMultipleObjects для мониторинга зарегистрированных операций ожидания. Таким образом, если необходимо использовать один и тот же собственный дескриптор операционной системы в нескольких вызовах RegisterWaitForSingleObject, необходимо дублировать дескриптор с помощью функции Win32 DuplicateHandle . Обратите внимание, что не следует пульсировать переданный объект RegisterWaitForSingleObjectсобытия, так как поток ожидания может не обнаружить, что событие сигнализируется перед сбросом.

Перед возвратом функция изменяет состояние некоторых типов объектов синхронизации. Изменение происходит только для объекта, сигнальное состояние которого привело к выполнению условия ожидания. Например, количество семафора уменьшается на один.

См. также раздел

• Управляемый пул потоков

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

Исходный код:

ThreadPoolWorkQueue.cs

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

Параметры

Возвращаемое значение

Инкапсулирует RegisteredWaitHandle собственный дескриптор.

Атрибуты

UnsupportedOSPlatformAttribute

Исключения

Комментарии

Завершив использование RegisteredWaitHandle этого метода, вызовите его RegisteredWaitHandle.Unregister метод для выпуска ссылок на дескриптор ожидания. Рекомендуется всегда вызывать RegisteredWaitHandle.Unregister метод, даже если указано true для executeOnlyOnce. Сборка мусора работает более эффективно, если метод вызывается RegisteredWaitHandle.Unregister вместо метода в зависимости от метода завершения зарегистрированного дескриптора ожидания.

Метод RegisterWaitForSingleObject очереди указанного делегата в пул потоков. Рабочий поток будет выполнять делегат, когда происходит одно из следующих действий:

• Указанный объект находится в сигнальном состоянии.
• Интервал ожидания истекает.

Метод RegisterWaitForSingleObject проверяет текущее состояние указанного объекта WaitHandle. Если состояние объекта не указано, метод регистрирует операцию ожидания. Операция ожидания выполняется потоком из пула потоков. Делегат выполняется рабочим потоком, когда состояние объекта становится сигналом или истекает интервал времени ожидания. timeOutInterval Если параметр не равен 0 (ноль) и executeOnlyOnce параметр falseимеет значение, таймер сбрасывается каждый раз, когда событие сигнализирует или истекает интервал времени ожидания.

Чтобы отменить операцию ожидания, вызовите RegisteredWaitHandle.Unregister метод.

Поток ожидания использует функцию Win32 WaitForMultipleObjects для мониторинга зарегистрированных операций ожидания. Таким образом, если необходимо использовать один и тот же собственный дескриптор операционной системы в нескольких вызовах RegisterWaitForSingleObject, необходимо дублировать дескриптор с помощью функции Win32 DuplicateHandle . Обратите внимание, что не следует пульсировать переданный объект RegisterWaitForSingleObjectсобытия, так как поток ожидания может не обнаружить, что событие сигнализируется перед сбросом.

Перед возвратом функция изменяет состояние некоторых типов объектов синхронизации. Изменение происходит только для объекта, сигнальное состояние которого привело к выполнению условия ожидания. Например, количество семафора уменьшается на один.

См. также раздел

• Управляемый пул потоков