WaitOrTimerCallback Делегат

Определение

public delegate void WaitOrTimerCallback(System::Object ^ state, bool timedOut);

public delegate void WaitOrTimerCallback(object? state, bool timedOut);

public delegate void WaitOrTimerCallback(object state, bool timedOut);

[System.Runtime.InteropServices.ComVisible(true)]
public delegate void WaitOrTimerCallback(object state, bool timedOut);

type WaitOrTimerCallback = delegate of obj * bool -> unit

[<System.Runtime.InteropServices.ComVisible(true)>]
type WaitOrTimerCallback = delegate of obj * bool -> unit

Public Delegate Sub WaitOrTimerCallback(state As Object, timedOut As Boolean)

Параметры

Атрибуты

ComVisibleAttribute

Примеры

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

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

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

В дополнение к TaskInfoRegisterWaitForSingleObject объекту вызов метода указывает 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

Комментарии

WaitOrTimerCallback представляет метод обратного вызова, который требуется выполнить при истечении времени ожидания зарегистрированного дескриптора ожидания или сигнала. Создайте делегат, передав метод обратного вызова конструктору WaitOrTimerCallback . Метод должен иметь подпись, показанную здесь.

Создайте зарегистрированный дескриптор WaitOrTimerCallback ожидания, передав делегат и в WaitHandleThreadPool.RegisterWaitForSingleObject. Метод обратного WaitHandle вызова выполняется каждый раз при истечении времени ожидания или сигнала.

Если вы хотите передать сведения в метод обратного вызова, создайте объект, содержащий необходимые сведения, и передайте его RegisterWaitForSingleObject при создании зарегистрированного дескриптора ожидания. При каждом выполнении state метода обратного вызова параметр содержит этот объект.

Дополнительные сведения об использовании методов обратного вызова для синхронизации потоков пула потоков см. в разделе "Управляемый пул потоков".

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

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