WaitOrTimerCallback 代理人

定義

名前空間:

System.Threading

アセンブリ:

netstandard.dll, System.Threading.ThreadPool.dll

ソース:

ThreadPoolWorkQueue.cs

WaitHandleが通知されるかタイムアウトしたときに呼び出されるメソッドを表します。

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

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

type WaitOrTimerCallback = delegate of obj * bool -> unit

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

パラメーター

state

Object

コールバック メソッドが実行するたびに使用される情報を含むオブジェクト。

timedOut

Boolean

true WaitHandleがタイムアウトした場合はfalse。通知された場合は。

例

次の例では、 WaitOrTimerCallback デリゲートを使用して、待機ハンドルが通知されたときに実行されるコールバック メソッドを表す方法を示します。

この例では、 RegisterWaitForSingleObject メソッドを使用して、指定した待機ハンドルが通知されたときに指定されたコールバック メソッドを実行する方法も示します。 この例では、コールバック メソッドは WaitProc され、待機ハンドルは AutoResetEventです。

この例では、実行時にコールバックに渡される情報を保持する TaskInfo クラスを定義します。 この例では、 TaskInfo オブジェクトを作成し、それに文字列データを割り当てます。 コールバック メソッドがRegisteredWaitHandleにアクセスできるように、RegisterWaitForSingleObject メソッドによって返されるHandleは、TaskInfo オブジェクトのRegisteredWaitHandle フィールドに割り当てられます。

TaskInfo オブジェクトに加えて、RegisterWaitForSingleObject メソッドの呼び出しでは、タスクが待機するAutoResetEvent、WaitOrTimerCallbackコールバック メソッド、1 秒のタイムアウト間隔、および複数のコールバックを表す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デリゲートとWaitHandleにThreadPool.RegisterWaitForSingleObjectを渡して、登録済みの待機ハンドルを作成します。 コールバック メソッドは、 WaitHandle がタイムアウトまたは通知されるたびに実行されます。

Note

Visual Basic ユーザーは、WaitOrTimerCallback コンストラクターを省略し、コールバック メソッドをAddressOfに渡すときに RegisterWaitForSingleObject 演算子を使用するだけです。 Visual Basic では、正しいデリゲート コンストラクターが自動的に呼び出されます。

コールバック メソッドに情報を渡す場合は、必要な情報を含むオブジェクトを作成し、登録された待機ハンドルを作成するときに RegisterWaitForSingleObject に渡します。 コールバック メソッドが実行されるたびに、 state パラメーターにこのオブジェクトが含まれます。

コールバック メソッドを使用してスレッド プール スレッドを同期する方法の詳細については、「 マネージド スレッド プール」を参照してください。

拡張メソッド

名前	説明
GetMethodInfo(Delegate)	指定したデリゲートによって表されるメソッドを表すオブジェクトを取得します。

こちらもご覧ください

• スレッドおよびスレッド処理
• マネージド スレッド プール