WaitCallback デリゲートとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

WaitCallback デリゲート

スレッドプールスレッドが実行するコールバックメソッドを表します。

名前空間: System.Threading
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

<ComVisibleAttribute(True)> _
Public Delegate Sub WaitCallback
 ( _
    state As Object _
)

Visual Basic (使用法)

Dim instance As New WaitCallback(AddressOf
 HandlerMethod)

[ComVisibleAttribute(true)] 
public delegate void WaitCallback (
    Object state
)

C++

[ComVisibleAttribute(true)] 
public delegate void WaitCallback (
    Object^ state
)

/** @delegate */
/** @attribute ComVisibleAttribute(true) */ 
public delegate void WaitCallback (
    Object state
)

JScript

JScript では、デリゲートは使用できますが、新規に宣言することはできません。

パラメータ

state: コールバックメソッドが使用する情報を格納したオブジェクト。

解説

WaitCallback は、ThreadPool スレッドで実行するコールバックメソッドを表します。デリゲートを作成するには、WaitCallback コンストラクタにコールバックメソッドを渡します。メソッドには、ここに示すシグネチャを付ける必要があります。

実行するためのキューにタスクを置くには、WaitCallback デリゲートを ThreadPool.QueueUserWorkItem に渡します。コールバックメソッドは、スレッドプールスレッドが使用可能になったときに実行されます。

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

コールバックメソッドに情報を渡す場合は、必要な情報を格納したオブジェクトを作成し、実行するためのキューにタスクを置くときにこのオブジェクトを QueueUserWorkItem に渡します。コールバックメソッドが実行されるたびに、state パラメータはこのオブジェクトを保持します。

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

使用例

Visual Basic

Imports System
Imports System.Threading

Public Class Example

    <MTAThread> _
    Public Shared Sub Main()
        ' Queue the task.
        ThreadPool.QueueUserWorkItem( _
            New WaitCallback(AddressOf ThreadProc)
 _
            )
        ' Note that you do not have to create the WaitCallback delegate
        ' explicitly in Visual Basic.  The following line also queues
 
        ' the task:
        'ThreadPool.QueueUserWorkItem(AddressOf ThreadProc)
        
        Console.WriteLine("Main thread does some work, then sleeps.")
        ' If you comment out the Sleep, the main thread exits before
        ' the thread pool task runs.  The thread pool uses background
        ' threads, which do not keep the application running.  (This
        ' is a simple example of a race condition.)
        Thread.Sleep(1000)

        Console.WriteLine("Main thread exits.")
    End Sub

    ' This thread procedure performs the task.
    Shared Sub ThreadProc(stateInfo As
 Object)
        ' No state object was passed to QueueUserWorkItem, so 
        ' stateInfo is null.
        Console.WriteLine("Hello from the thread pool.")
    End Sub
End Class

using System;
using System.Threading;
public class Example {
    public static void Main()
 {
        // Queue the task.
        ThreadPool.QueueUserWorkItem(new WaitCallback(ThreadProc));
        
        Console.WriteLine("Main thread does some work, then sleeps.");
        // If you comment out the Sleep, the main thread exits before
        // the thread pool task runs.  The thread pool uses background
        // threads, which do not keep the application running.  (This
        // is a simple example of a race condition.)
        Thread.Sleep(1000);

        Console.WriteLine("Main thread exits.");
    }

    // This thread procedure performs the task.
    static void ThreadProc(Object stateInfo)
 {
        // No state object was passed to QueueUserWorkItem, so 
        // stateInfo is null.
        Console.WriteLine("Hello from the thread pool.");
    }
}

C++

using namespace System;
using namespace System::Threading;
ref class Example
{
public:

   // This thread procedure performs the task.
   static void ThreadProc( Object^ stateInfo
 )
   {
      
      // No state object was passed to QueueUserWorkItem, so 
      // stateInfo is 0.
      Console::WriteLine( "Hello from the thread pool." );
   }

};

int main()
{
   
   // Queue the task.
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( Example::ThreadProc ) );
   Console::WriteLine( "Main thread does some work, then sleeps." );
   
   // If you comment out the Sleep, the main thread exits before
   // the thread pool task runs.  The thread pool uses background
   // threads, which do not keep the application running.  (This
   // is a simple example of a race condition.)
   Thread::Sleep( 1000 );
   Console::WriteLine( "Main thread exits." );
   return 0;
}

import System.*;
import System.Threading.*;
import System.Threading.Thread;

public class Example
{
    public static void main(String[]
 args)
    {
        // Queue the task.
        ThreadPool.QueueUserWorkItem(new WaitCallback(ThreadProc));
        Console.WriteLine("Main thread does some work, then sleeps.");

        // If you comment out the Sleep, the main thread exits before
        // the thread pool task runs.  The thread pool uses background
        // threads, which do not keep the application running.  (This
        // is a simple example of a race condition.)
        Thread.Sleep(1000);
        Console.WriteLine("Main thread exits.");
    } //main

    // This thread procedure performs the task.
    static void ThreadProc(Object stateInfo)
    {
        // No state object was passed to QueueUserWorkItem, so 
        // stateInfo is null.
        Console.WriteLine("Hello from the thread pool.");
    } //ThreadProc
} //Example