WaitOrTimerCallback 代理人

定義

名前空間:

System.Threading

アセンブリ:

System.Threading.ThreadPool.dll

アセンブリ:

mscorlib.dll

アセンブリ:

netstandard.dll

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

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)

パラメーター

state

Object

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

timedOut

Boolean

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

属性

ComVisibleAttribute

例

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

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

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

オブジェクトにTaskInfo加えて、メソッドのRegisterWaitForSingleObject呼び出しでは、タスクの待機、コールバック メソッドをWaitOrTimerCallback表すWaitProcデリゲート、1 秒のタイムアウト間隔、および複数のコールバックを指定AutoResetEventします。

メイン スレッドがメソッドを AutoResetEvent 呼び出 Set して通知すると、 WaitOrTimerCallback デリゲートが呼び出されます。 このメソッドは WaitProc 、 RegisteredWaitHandle タイムアウトが発生したかどうかを調べます。 待機ハンドルが通知されたためにコールバックが呼び出された場合、メソッドは WaitProc コールバックの RegisteredWaitHandle登録を解除し、それ以降のコールバックを停止します。 タイムアウトの場合、タスクは待機を続けます。 メソッドは WaitProc 、コンソールにメッセージを印刷することによって終了します。

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

注釈

WaitOrTimerCallback は、登録済みの待機ハンドルがタイムアウトしたとき、またはシグナルが送信されたときに実行するコールバック メソッドを表します。 コールバック メソッドをコンストラクターに渡して、デリゲートを WaitOrTimerCallback 作成します。 メソッドには、ここに示されているシグネチャが必要です。

デリゲートと to を渡 WaitOrTimerCallback して、登録済みの待機ハンドルを WaitHandle 作成します ThreadPool.RegisterWaitForSingleObject。 コールバック メソッドは、タイムアウトまたはシグナルが WaitHandle 送信されるたびに実行されます。

注意

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

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

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

拡張メソッド

GetMethodInfo(Delegate)

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

こちらもご覧ください

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