ThreadPool.RegisterWaitForSingleObject メソッド

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);

[<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

例外

例

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

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

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

メイン スレッドがSet メソッドを呼び出してAutoResetEventに通知すると、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 メソッドを呼び出して、待機ハンドルへの参照を解放します。 executeOnlyOnceのtrueを指定した場合でも、常に RegisteredWaitHandle.Unregister メソッドを呼び出することをお勧めします。 登録されている待機ハンドルのファイナライザーに応じてではなく、 RegisteredWaitHandle.Unregister メソッドを呼び出すと、ガベージ コレクションがより効率的に動作します。

RegisterWaitForSingleObject メソッドは、指定したデリゲートをスレッド プールにキューに入れます。 ワーカー スレッドは、次のいずれかが発生したときにデリゲートを実行します。

• 指定されたオブジェクトがシグナル状態です。
• タイムアウト間隔が経過します。

RegisterWaitForSingleObject メソッドは、指定したオブジェクトのWaitHandleの現在の状態を確認します。 オブジェクトの状態が署名されていない場合、メソッドは待機操作を登録します。 待機操作は、スレッド プールのスレッドによって実行されます。 オブジェクトの状態が通知されるか、タイムアウト間隔が経過すると、デリゲートはワーカー スレッドによって実行されます。 timeOutInterval パラメーターが 0 (ゼロ) ではなく、executeOnlyOnce パラメーターがfalse場合、イベントが通知されるかタイムアウト間隔が経過するたびにタイマーがリセットされます。

待機操作を取り消すには、 RegisteredWaitHandle.Unregister メソッドを呼び出します。

待機スレッドは、Win32 WaitForMultipleObjects 関数を使用して、登録済みの待機操作を監視します。 そのため、 RegisterWaitForSingleObjectの複数の呼び出しで同じネイティブ オペレーティング システム ハンドルを使用する必要がある場合は、Win32 DuplicateHandle 関数を使用してハンドルを複製する必要があります。 待機スレッドでは、イベントがリセットされる前に通知されないことがあるため、 RegisterWaitForSingleObjectに渡されたイベント オブジェクトをパルス化しないでください。

戻る前に、関数は一部の種類の同期オブジェクトの状態を変更します。 変更は、シグナル状態が原因で待機条件が満たされたオブジェクトに対してのみ行われます。 たとえば、セマフォの数は 1 ずつ減少します。

こちらもご覧ください

• マネージド スレッド プール

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

パラメーター

返品

ネイティブ ハンドルをカプセル化する RegisteredWaitHandle 。

例外

注釈

このメソッドによって返される RegisteredWaitHandle の使用が完了したら、その RegisteredWaitHandle.Unregister メソッドを呼び出して、待機ハンドルへの参照を解放します。 executeOnlyOnceのtrueを指定した場合でも、常に RegisteredWaitHandle.Unregister メソッドを呼び出することをお勧めします。 登録されている待機ハンドルのファイナライザーに応じてではなく、 RegisteredWaitHandle.Unregister メソッドを呼び出すと、ガベージ コレクションがより効率的に動作します。

RegisterWaitForSingleObject メソッドは、指定したデリゲートをスレッド プールにキューに入れます。 ワーカー スレッドは、次のいずれかが発生したときにデリゲートを実行します。

• 指定されたオブジェクトがシグナル状態です。
• タイムアウト間隔が経過します。

RegisterWaitForSingleObject メソッドは、指定したオブジェクトのWaitHandleの現在の状態を確認します。 オブジェクトの状態が署名されていない場合、メソッドは待機操作を登録します。 待機操作は、スレッド プールのスレッドによって実行されます。 オブジェクトの状態が通知されるか、タイムアウト間隔が経過すると、デリゲートはワーカー スレッドによって実行されます。 timeOutInterval パラメーターが 0 (ゼロ) ではなく、executeOnlyOnce パラメーターがfalse場合、イベントが通知されるかタイムアウト間隔が経過するたびにタイマーがリセットされます。

待機操作を取り消すには、 RegisteredWaitHandle.Unregister メソッドを呼び出します。

待機スレッドは、Win32 WaitForMultipleObjects 関数を使用して、登録済みの待機操作を監視します。 そのため、 RegisterWaitForSingleObjectの複数の呼び出しで同じネイティブ オペレーティング システム ハンドルを使用する必要がある場合は、Win32 DuplicateHandle 関数を使用してハンドルを複製する必要があります。 待機スレッドでは、イベントがリセットされる前に通知されないことがあるため、 RegisterWaitForSingleObjectに渡されたイベント オブジェクトをパルス化しないでください。

戻る前に、関数は一部の種類の同期オブジェクトの状態を変更します。 変更は、シグナル状態が原因で待機条件が満たされたオブジェクトに対してのみ行われます。 たとえば、セマフォの数は 1 ずつ減少します。

こちらもご覧ください

• マネージド スレッド プール

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

パラメーター

返品

ネイティブ ハンドルをカプセル化する RegisteredWaitHandle 。

例外

注釈

このメソッドによって返される RegisteredWaitHandle の使用が完了したら、その RegisteredWaitHandle.Unregister メソッドを呼び出して、待機ハンドルへの参照を解放します。 executeOnlyOnceのtrueを指定した場合でも、常に RegisteredWaitHandle.Unregister メソッドを呼び出することをお勧めします。 登録されている待機ハンドルのファイナライザーに応じてではなく、 RegisteredWaitHandle.Unregister メソッドを呼び出すと、ガベージ コレクションがより効率的に動作します。

RegisterWaitForSingleObject メソッドは、指定したデリゲートをスレッド プールにキューに入れます。 ワーカー スレッドは、次のいずれかが発生したときにデリゲートを実行します。

• 指定されたオブジェクトがシグナル状態です。
• タイムアウト間隔が経過します。

RegisterWaitForSingleObject メソッドは、指定したオブジェクトのWaitHandleの現在の状態を確認します。 オブジェクトの状態が署名されていない場合、メソッドは待機操作を登録します。 待機操作は、スレッド プールのスレッドによって実行されます。 オブジェクトの状態が通知されるか、タイムアウト間隔が経過すると、デリゲートはワーカー スレッドによって実行されます。 timeOutInterval パラメーターが 0 (ゼロ) ではなく、executeOnlyOnce パラメーターがfalse場合、イベントが通知されるかタイムアウト間隔が経過するたびにタイマーがリセットされます。

待機操作を取り消すには、 RegisteredWaitHandle.Unregister メソッドを呼び出します。

待機スレッドは、Win32 WaitForMultipleObjects 関数を使用して、登録済みの待機操作を監視します。 そのため、 RegisterWaitForSingleObjectの複数の呼び出しで同じネイティブ オペレーティング システム ハンドルを使用する必要がある場合は、Win32 DuplicateHandle 関数を使用してハンドルを複製する必要があります。 待機スレッドでは、イベントがリセットされる前に通知されないことがあるため、 RegisterWaitForSingleObjectに渡されたイベント オブジェクトをパルス化しないでください。

戻る前に、関数は一部の種類の同期オブジェクトの状態を変更します。 変更は、シグナル状態が原因で待機条件が満たされたオブジェクトに対してのみ行われます。 たとえば、セマフォの数は 1 ずつ減少します。

こちらもご覧ください

• マネージド スレッド プール

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

パラメーター

返品

ネイティブ ハンドルをカプセル化する RegisteredWaitHandle 。

例外

注釈

このメソッドによって返される RegisteredWaitHandle の使用が完了したら、その RegisteredWaitHandle.Unregister メソッドを呼び出して、待機ハンドルへの参照を解放します。 executeOnlyOnceのtrueを指定した場合でも、常に RegisteredWaitHandle.Unregister メソッドを呼び出することをお勧めします。 登録されている待機ハンドルのファイナライザーに応じてではなく、 RegisteredWaitHandle.Unregister メソッドを呼び出すと、ガベージ コレクションがより効率的に動作します。

RegisterWaitForSingleObject メソッドは、指定したデリゲートをスレッド プールにキューに入れます。 ワーカー スレッドは、次のいずれかが発生したときにデリゲートを実行します。

• 指定されたオブジェクトがシグナル状態です。
• タイムアウト間隔が経過します。

RegisterWaitForSingleObject メソッドは、指定したオブジェクトのWaitHandleの現在の状態を確認します。 オブジェクトの状態が署名されていない場合、メソッドは待機操作を登録します。 待機操作は、スレッド プールのスレッドによって実行されます。 オブジェクトの状態が通知されるか、タイムアウト間隔が経過すると、デリゲートはワーカー スレッドによって実行されます。 timeOutInterval パラメーターが 0 (ゼロ) ではなく、executeOnlyOnce パラメーターがfalse場合、イベントが通知されるかタイムアウト間隔が経過するたびにタイマーがリセットされます。

待機操作を取り消すには、 RegisteredWaitHandle.Unregister メソッドを呼び出します。

待機スレッドは、Win32 WaitForMultipleObjects 関数を使用して、登録済みの待機操作を監視します。 そのため、 RegisterWaitForSingleObjectの複数の呼び出しで同じネイティブ オペレーティング システム ハンドルを使用する必要がある場合は、Win32 DuplicateHandle 関数を使用してハンドルを複製する必要があります。 待機スレッドでは、イベントがリセットされる前に通知されないことがあるため、 RegisterWaitForSingleObjectに渡されたイベント オブジェクトをパルス化しないでください。

戻る前に、関数は一部の種類の同期オブジェクトの状態を変更します。 変更は、シグナル状態が原因で待機条件が満たされたオブジェクトに対してのみ行われます。 たとえば、セマフォの数は 1 ずつ減少します。

こちらもご覧ください

• マネージド スレッド プール