WaitHandleとは何？わかりやすく解説 Weblio辞書

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

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

WaitHandle クラス

共有リソースへの排他アクセスの待機に使用するオペレーティングシステム固有のオブジェクトをカプセル化します。

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

Visual Basic (宣言)

<ComVisibleAttribute(True)> _
Public MustInherit Class
 WaitHandle
    Inherits MarshalByRefObject
    Implements IDisposable

Visual Basic (使用法)

Dim instance As WaitHandle

[ComVisibleAttribute(true)] 
public abstract class WaitHandle : MarshalByRefObject,
 IDisposable

C++

[ComVisibleAttribute(true)] 
public ref class WaitHandle abstract : public
 MarshalByRefObject, IDisposable

/** @attribute ComVisibleAttribute(true) */ 
public abstract class WaitHandle extends MarshalByRefObject
 implements IDisposable

JScript

ComVisibleAttribute(true) 
public abstract class WaitHandle extends
 MarshalByRefObject implements IDisposable

解説

このクラスは、通常、同期オブジェクトの基本クラスとして使用されます。WaitHandle から派生したクラスは、共有リソースへのアクセスの取得または解放を示すシグナル通知機構を定義しますが、共有リソースへのアクセスを待機している間にブロックするには、継承した WaitHandle メソッドを使用します。

このクラスの静的メソッドを使用して、1 つ以上の同期オブジェクトがシグナルを受信するまでスレッドをブロックします。

使用例

2 つのスレッドがバックグラウンドタスクを実行し、その間にメインスレッドが WaitHandle クラスの WaitAny 静的メソッドおよび WaitAll 静的メソッドを使用してタスクの完了を待機できるようにするコード例を次に示します。

Visual Basic

Imports System
Imports System.Threading

NotInheritable Public Class
 App
    ' Define an array with two AutoResetEvent WaitHandles.
    Private Shared waitHandles() As
 WaitHandle = _
        {New AutoResetEvent(False), New AutoResetEvent(False)}
    
    ' Define a random number generator for testing.
    Private Shared r As
 New Random()
    
    <MTAThreadAttribute> _
    Public Shared Sub Main()
 
        ' Queue two tasks on two different threads; 
        ' wait until all tasks are completed.
        Dim dt As DateTime = DateTime.Now
        Console.WriteLine("Main thread is waiting for BOTH tasks
 to complete.")
        ThreadPool.QueueUserWorkItem(AddressOf DoTask, waitHandles(0))
        ThreadPool.QueueUserWorkItem(AddressOf DoTask, waitHandles(1))
        WaitHandle.WaitAll(waitHandles)
        ' The time shown below should match the longest task.
        Console.WriteLine("Both tasks are completed (time waited={0})",
 _
            (DateTime.Now - dt).TotalMilliseconds)
        
        ' Queue up two tasks on two different threads; 
        ' wait until any tasks are completed.
        dt = DateTime.Now
        Console.WriteLine()
        Console.WriteLine("The main thread is waiting for either
 task to complete.")
        ThreadPool.QueueUserWorkItem(AddressOf DoTask, waitHandles(0))
        ThreadPool.QueueUserWorkItem(AddressOf DoTask, waitHandles(1))
        Dim index As Integer
 = WaitHandle.WaitAny(waitHandles)
        ' The time shown below should match the shortest task.
        Console.WriteLine("Task {0} finished first (time waited={1}).",
 _
            index + 1,(DateTime.Now - dt).TotalMilliseconds)
    
    End Sub 'Main
    
    Shared Sub DoTask(ByVal
 state As [Object]) 
        Dim are As AutoResetEvent = CType(state,
 AutoResetEvent)
        Dim time As Integer
 = 1000 * r.Next(2, 10)
        Console.WriteLine("Performing a task for {0} milliseconds.",
 time)
        Thread.Sleep(time)
        are.Set()
    
    End Sub 'DoTask
End Class 'App

' This code produces output similar to the following:
'
'  Main thread is waiting for BOTH tasks to complete.
'  Performing a task for 7000 milliseconds.
'  Performing a task for 4000 milliseconds.
'  Both tasks are completed (time waited=7064.8052)
' 
'  The main thread is waiting for either task to complete.
'  Performing a task for 2000 milliseconds.
'  Performing a task for 2000 milliseconds.
'  Task 1 finished first (time waited=2000.6528).

using System;
using System.Threading;

public sealed class App 
{
    // Define an array with two AutoResetEvent WaitHandles.
    static WaitHandle[] waitHandles = new WaitHandle[]
 
    {
        new AutoResetEvent(false),
        new AutoResetEvent(false)
    };

    // Define a random number generator for testing.
    static Random r = new Random();

    static void Main() 
    {
        // Queue up two tasks on two different threads; 
        // wait until all tasks are completed.
        DateTime dt = DateTime.Now;
        Console.WriteLine("Main thread is waiting for BOTH
 tasks to complete.");
        ThreadPool.QueueUserWorkItem(new WaitCallback(DoTask),
 waitHandles[0]);
        ThreadPool.QueueUserWorkItem(new WaitCallback(DoTask),
 waitHandles[1]);
        WaitHandle.WaitAll(waitHandles);
        // The time shown below should match the longest task.
        Console.WriteLine("Both tasks are completed (time waited={0})",
 
            (DateTime.Now - dt).TotalMilliseconds);

        // Queue up two tasks on two different threads; 
        // wait until any tasks are completed.
        dt = DateTime.Now;
        Console.WriteLine();
        Console.WriteLine("The main thread is waiting for
 either task to complete.");
        ThreadPool.QueueUserWorkItem(new WaitCallback(DoTask),
 waitHandles[0]);
        ThreadPool.QueueUserWorkItem(new WaitCallback(DoTask),
 waitHandles[1]);
        int index = WaitHandle.WaitAny(waitHandles);
        // The time shown below should match the shortest task.
        Console.WriteLine("Task {0} finished first (time waited={1})."
,
            index + 1, (DateTime.Now - dt).TotalMilliseconds);
    }

    static void DoTask(Object state) 
    {
        AutoResetEvent are = (AutoResetEvent) state;
        int time = 1000 * r.Next(2, 10);
        Console.WriteLine("Performing a task for {0} milliseconds.",
 time);
        Thread.Sleep(time);
        are.Set();
    }
}

// This code produces output similar to the following:
//
//  Main thread is waiting for BOTH tasks to complete.
//  Performing a task for 7000 milliseconds.
//  Performing a task for 4000 milliseconds.
//  Both tasks are completed (time waited=7064.8052)
// 
//  The main thread is waiting for either task to complete.
//  Performing a task for 2000 milliseconds.
//  Performing a task for 2000 milliseconds.
//  Task 1 finished first (time waited=2000.6528).

C++

using namespace System;
using namespace System::Threading;

public ref class WaitHandleExample
{
    // Define a random number generator for testing.
private:
    static Random^ random = gcnew Random();
public:
    static void DoTask(Object^ state)
    {
        AutoResetEvent^ autoReset = (AutoResetEvent^) state;
        int time = 1000 * random->Next(2, 10);
        Console::WriteLine("Performing a task for {0} milliseconds.",
 time);
        Thread::Sleep(time);
        autoReset->Set();
    }
};

int main()
{
    // Define an array with two AutoResetEvent WaitHandles.
    array<WaitHandle^>^ handles = gcnew array<WaitHandle^> {
        gcnew AutoResetEvent(false), gcnew AutoResetEvent(false)};

    // Queue up two tasks on two different threads;
    // wait until all tasks are completed.
    DateTime timeInstance = DateTime::Now;
    Console::WriteLine("Main thread is waiting for BOTH tasks
 to " +
        "complete.");
    ThreadPool::QueueUserWorkItem(
        gcnew WaitCallback(WaitHandleExample::DoTask), handles[0]);
    ThreadPool::QueueUserWorkItem(
        gcnew WaitCallback(WaitHandleExample::DoTask), handles[1]);
    WaitHandle::WaitAll(handles);
    // The time shown below should match the longest task.
    Console::WriteLine("Both tasks are completed (time waited={0})",
        (DateTime::Now - timeInstance).TotalMilliseconds);

    // Queue up two tasks on two different threads;
    // wait until any tasks are completed.
    timeInstance = DateTime::Now;
    Console::WriteLine();
    Console::WriteLine("The main thread is waiting for either
 task to " +
        "complete.");
    ThreadPool::QueueUserWorkItem(
        gcnew WaitCallback(WaitHandleExample::DoTask), handles[0]);
    ThreadPool::QueueUserWorkItem(
        gcnew WaitCallback(WaitHandleExample::DoTask), handles[1]);
    int index = WaitHandle::WaitAny(handles);
    // The time shown below should match the shortest task.
    Console::WriteLine("Task {0} finished first (time waited={1}).",
        index + 1, (DateTime::Now - timeInstance).TotalMilliseconds);
}

// This code produces the following sample output.
//
// Main thread is waiting for BOTH tasks to complete.
// Performing a task for 7000 milliseconds.
// Performing a task for 4000 milliseconds.
// Both tasks are completed (time waited=7064.8052)

// The main thread is waiting for either task to complete.
// Performing a task for 2000 milliseconds.
// Performing a task for 2000 milliseconds.
// Task 1 finished first (time waited=2000.6528).

継承階層

System.Object
   System.MarshalByRefObject
    System.Threading.WaitHandle
       System.Threading.EventWaitHandle
       System.Threading.Mutex
       System.Threading.Semaphore

スレッドセーフ

この型は、スレッドセーフです。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
WaitHandle メンバ
System.Threading 名前空間
その他の技術情報
待機ハンドル

WaitHandle コンストラクタ

WaitHandle クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Protected Sub New

Visual Basic (使用法)

Dim instance As New WaitHandle

protected WaitHandle ()

C++

protected:
WaitHandle ()

protected WaitHandle ()

JScript

protected function WaitHandle ()

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
WaitHandle クラス
WaitHandle メンバ
System.Threading 名前空間

WaitHandle フィールド

パブリックフィールドパブリックフィールド

( プロテクトフィールドも参照)

	名前	説明
	WaitTimeout	待機ハンドルがシグナル状態になる前に WaitAny 操作がタイムアウトになったことを示します。このフィールドは定数です。

プロテクトフィールド

	名前	説明
	InvalidHandle	無効なネイティブオペレーティングシステムハンドルを表します。このフィールドは読み取り専用です。

参照

その他の技術情報

待機ハンドル

WaitHandle プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	SafeWaitHandle	ネイティブオペレーティングシステムハンドルを取得または設定します。

参照

その他の技術情報

待機ハンドル

WaitHandle メソッド

パブリックメソッドパブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Close	派生クラスでオーバーライドされると、現在の WaitHandle で保持されているすべてのリソースを解放します。
	CreateObjRef	リモートオブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 ( MarshalByRefObject から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービスオブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービスオブジェクトを取得します。 ( MarshalByRefObject から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	SignalAndWait	オーバーロードされます。分割不可能な操作として、1 つの WaitHandle を通知し、別の WaitHandle を待機します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)
	WaitAll	オーバーロードされます。指定した配列内のすべての要素がシグナルを受信するまで待機します。
	WaitAny	オーバーロードされます。指定した配列内のいずれかの要素がシグナルを受信するまで待機します。
	WaitOne	オーバーロードされます。派生クラスでオーバーライドされると、現在の WaitHandle がシグナルを受信するまで現在のスレッドをブロックします。

プロテクトメソッド

	名前	説明
	Dispose	派生クラスでオーバーライドされると、WaitHandle によって使用されているアンマネージリソースを解放し、オプションでマネージリソースも解放します。
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	オーバーロードされます。 ( MarshalByRefObject から継承されます。)

明示的インターフェイスの実装

	名前	説明
	System.IDisposable.Dispose	WaitHandle によって使用されているすべてのリソースを解放します。

参照

その他の技術情報

待機ハンドル

WaitHandle メンバ

共有リソースへの排他アクセスの待機に使用するオペレーティングシステム固有のオブジェクトをカプセル化します。

WaitHandle データ型で公開されるメンバを以下の表に示します。

プロテクトコンストラクタ

	名前	説明
	WaitHandle	WaitHandle クラスの新しいインスタンスを初期化します。

パブリックフィールド

( プロテクトフィールドも参照)

	名前	説明
	WaitTimeout	待機ハンドルがシグナル状態になる前に WaitAny 操作がタイムアウトになったことを示します。このフィールドは定数です。

プロテクトフィールド

	名前	説明
	InvalidHandle	無効なネイティブオペレーティングシステムハンドルを表します。このフィールドは読み取り専用です。

パブリックプロパティ

	名前	説明
	SafeWaitHandle	ネイティブオペレーティングシステムハンドルを取得または設定します。

パブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Close	派生クラスでオーバーライドされると、現在の WaitHandle で保持されているすべてのリソースを解放します。
	CreateObjRef	リモートオブジェクトとの通信に使用するプロキシの生成に必要な情報をすべて格納しているオブジェクトを作成します。 (MarshalByRefObject から継承されます。)
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、現在の有効期間サービスオブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	InitializeLifetimeService	対象のインスタンスの有効期間ポリシーを制御する、有効期間サービスオブジェクトを取得します。 (MarshalByRefObject から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	SignalAndWait	オーバーロードされます。分割不可能な操作として、1 つの WaitHandle を通知し、別の WaitHandle を待機します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)
	WaitAll	オーバーロードされます。指定した配列内のすべての要素がシグナルを受信するまで待機します。
	WaitAny	オーバーロードされます。指定した配列内のいずれかの要素がシグナルを受信するまで待機します。
	WaitOne	オーバーロードされます。派生クラスでオーバーライドされると、現在の WaitHandle がシグナルを受信するまで現在のスレッドをブロックします。

プロテクトメソッド

	名前	説明
	Dispose	派生クラスでオーバーライドされると、WaitHandle によって使用されているアンマネージリソースを解放し、オプションでマネージリソースも解放します。
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	オーバーロードされます。 ( MarshalByRefObject から継承されます。)