EventWaitHandle コンストラクター

定義

名前空間:

System.Threading

アセンブリ:

System.Threading.dll

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

オーバーロード

EventWaitHandle(Boolean, EventResetMode)	待機ハンドルの初期状態をシグナル状態に設定するかどうか、および、待機ハンドルが自動的にリセットされるかまたは手動でリセットされるかを指定して、EventWaitHandle クラスの新しいインスタンスを初期化します。
EventWaitHandle(Boolean, EventResetMode, String)	この呼び出しの結果として待機ハンドルが作成された場合に待機ハンドルの初期状態をシグナル状態に設定するかどうか、待機ハンドルが自動的にリセットされるかまたは手動でリセットされるか、およびシステムの同期イベントの名前を指定して、EventWaitHandle クラスの新しいインスタンスを初期化します。
EventWaitHandle(Boolean, EventResetMode, String, Boolean)	EventWaitHandle クラスの新しいインスタンスを初期化し、待機ハンドルがこの呼び出しの結果として作成された場合に最初にシグナル状態になるかどうか、リセットは自動または手動か、システムの同期イベントの名前、呼び出しの後の値で名前の付いたシステム イベントが作成されたかどうかを示すブール値変数を指定します。

EventWaitHandle(Boolean, EventResetMode)

ソース:

EventWaitHandle.cs

待機ハンドルの初期状態をシグナル状態に設定するかどうか、および、待機ハンドルが自動的にリセットされるかまたは手動でリセットされるかを指定して、EventWaitHandle クラスの新しいインスタンスを初期化します。

C#

public EventWaitHandle (bool initialState, System.Threading.EventResetMode mode);

パラメーター

initialState

Boolean

初期状態をシグナル状態に設定する場合は true。非シグナル状態に設定する場合は false。

mode

EventResetMode

イベントが自動的にリセットされるかまたは手動でリセットされるかを指定する EventResetMode 値の 1 つ。

例外

ArgumentException

mode 列挙値が適正範囲外でした。

例

次のコード例では、 メソッド オーバーロードを SignalAndWait(WaitHandle, WaitHandle) 使用して、メイン スレッドがブロックされたスレッドに通知し、スレッドがタスクを完了するまで待機できるようにします。

この例では、5 つのスレッドを開始し、 フラグを使用EventResetMode.AutoResetして作成された をEventWaitHandleブロックし、ユーザーが Enter キーを押すたびに 1 つのスレッドを解放できるようにします。 次に、この例では、別の 5 つのスレッドをキューに入れ、 フラグでEventResetMode.ManualReset作成された をEventWaitHandle使用して、それらすべてを解放します。

C#

using System;
using System.Threading;

public class Example
{
    // The EventWaitHandle used to demonstrate the difference
    // between AutoReset and ManualReset synchronization events.
    //
    private static EventWaitHandle ewh;

    // A counter to make sure all threads are started and
    // blocked before any are released. A Long is used to show
    // the use of the 64-bit Interlocked methods.
    //
    private static long threadCount = 0;

    // An AutoReset event that allows the main thread to block
    // until an exiting thread has decremented the count.
    //
    private static EventWaitHandle clearCount = 
        new EventWaitHandle(false, EventResetMode.AutoReset);

    [MTAThread]
    public static void Main()
    {
        // Create an AutoReset EventWaitHandle.
        //
        ewh = new EventWaitHandle(false, EventResetMode.AutoReset);

        // Create and start five numbered threads. Use the
        // ParameterizedThreadStart delegate, so the thread
        // number can be passed as an argument to the Start 
        // method.
        for (int i = 0; i <= 4; i++)
        {
            Thread t = new Thread(
                new ParameterizedThreadStart(ThreadProc)
            );
            t.Start(i);
        }

        // Wait until all the threads have started and blocked.
        // When multiple threads use a 64-bit value on a 32-bit
        // system, you must access the value through the
        // Interlocked class to guarantee thread safety.
        //
        while (Interlocked.Read(ref threadCount) < 5)
        {
            Thread.Sleep(500);
        }

        // Release one thread each time the user presses ENTER,
        // until all threads have been released.
        //
        while (Interlocked.Read(ref threadCount) > 0)
        {
            Console.WriteLine("Press ENTER to release a waiting thread.");
            Console.ReadLine();

            // SignalAndWait signals the EventWaitHandle, which
            // releases exactly one thread before resetting, 
            // because it was created with AutoReset mode. 
            // SignalAndWait then blocks on clearCount, to 
            // allow the signaled thread to decrement the count
            // before looping again.
            //
            WaitHandle.SignalAndWait(ewh, clearCount);
        }
        Console.WriteLine();

        // Create a ManualReset EventWaitHandle.
        //
        ewh = new EventWaitHandle(false, EventResetMode.ManualReset);

        // Create and start five more numbered threads.
        //
        for(int i=0; i<=4; i++)
        {
            Thread t = new Thread(
                new ParameterizedThreadStart(ThreadProc)
            );
            t.Start(i);
        }

        // Wait until all the threads have started and blocked.
        //
        while (Interlocked.Read(ref threadCount) < 5)
        {
            Thread.Sleep(500);
        }

        // Because the EventWaitHandle was created with
        // ManualReset mode, signaling it releases all the
        // waiting threads.
        //
        Console.WriteLine("Press ENTER to release the waiting threads.");
        Console.ReadLine();
        ewh.Set();
    }

    public static void ThreadProc(object data)
    {
        int index = (int) data;

        Console.WriteLine("Thread {0} blocks.", data);
        // Increment the count of blocked threads.
        Interlocked.Increment(ref threadCount);

        // Wait on the EventWaitHandle.
        ewh.WaitOne();

        Console.WriteLine("Thread {0} exits.", data);
        // Decrement the count of blocked threads.
        Interlocked.Decrement(ref threadCount);

        // After signaling ewh, the main thread blocks on
        // clearCount until the signaled thread has 
        // decremented the count. Signal it now.
        //
        clearCount.Set();
    }
}

注釈

イベントの初期状態が非署名の場合、イベントを待機するスレッドはブロックされます。 初期状態が通知され、 ManualReset フラグが に mode指定されている場合、イベントを待機するスレッドはブロックされません。 初期状態が 通知され、 が のAutoReset場合、modeイベントを待機する最初のスレッドが直ちに解放され、その後イベントがリセットされ、後続のスレッドがブロックされます。

こちらもご覧ください

• 同期プリミティブの概要

EventWaitHandle(Boolean, EventResetMode, String)

ソース:

EventWaitHandle.cs

この呼び出しの結果として待機ハンドルが作成された場合に待機ハンドルの初期状態をシグナル状態に設定するかどうか、待機ハンドルが自動的にリセットされるかまたは手動でリセットされるか、およびシステムの同期イベントの名前を指定して、EventWaitHandle クラスの新しいインスタンスを初期化します。

C#

public EventWaitHandle (bool initialState, System.Threading.EventResetMode mode, string? name);

パラメーター

initialState

Boolean

名前の付いたイベントがこの呼び出しの結果として作成された場合に、初期状態をシグナル状態に設定するには true、非シグナル状態に設定するには false。

mode

EventResetMode

イベントが自動的にリセットされるかまたは手動でリセットされるかを指定する EventResetMode 値の 1 つ。

name

String

同期オブジェクトが他のプロセスと共有される場合は、名前。それ以外の場合は、null または空の文字列。 名前の大文字と小文字は区別されます。 円記号 (\) は予約されており、名前空間の指定にのみ使用できます。 名前空間の詳細については、「解説」セクションを参照してください。 オペレーティング システムによっては、名前にさらに制限がある場合があります。 たとえば、Unix ベースのオペレーティング システムでは、名前空間を除外した後の名前は有効なファイル名である必要があります。

例外

IOException

name が無効です。 これは、不明なプレフィックスや無効な文字など、オペレーティング システムによって配置される可能性のある制限など、さまざまな理由で発生する可能性があります。 名前と共通プレフィックス "Global\" と "Local\" では大文字と小文字が区別されることに注意してください。

または

その他のエラーが発生しました。 HResult プロパティにさらに情報が含まれている場合があります。

DirectoryNotFoundException

Windows のみ: name により不明な名前空間が指定されました。 詳しくは、「オブジェクト名」をご覧ください。

PathTooLongException

name は長すぎます。 長さの制限は、オペレーティング システムまたは構成によって異なる場合があります。

UnauthorizedAccessException

アクセス制御セキュリティを使用した名前付きイベントが存在しますが、ユーザーに FullControl がありません。

WaitHandleCannotBeOpenedException

指定された name を持つ同期オブジェクトを作成できません。 別の型の同期オブジェクトに同じ名前が指定されている可能性があります。

ArgumentException

mode 列挙値が適正範囲外でした。

または

.NET Framework のみ: name MAX_PATH (260 文字) を超えています。

注釈

名前空間を name 指定するには、 の前 Global\ に または Local\ を付けます。 名前空間を Global 指定すると、同期オブジェクトをシステム上の任意のプロセスと共有できます。 名前空間が Local 指定されている場合 (名前空間が指定されていない場合も既定値) は、同期オブジェクトを同じセッション内のプロセスと共有できます。 Windows では、セッションはログイン セッションであり、通常、サービスは別の非対話型セッションで実行されます。 Unix に似たオペレーティング システムでは、各シェルに独自のセッションがあります。 セッションとローカルの同期オブジェクトは、プロセス間の同期に適している場合があります。これらはすべて同じセッションで実行される親子関係を持ちます。 Windows での同期オブジェクト名の詳細については、「 オブジェクト名」を参照してください。

nameが指定され、要求された型の同期オブジェクトが名前空間に既に存在する場合は、既存の同期オブジェクトが開かれます。 別の型の同期オブジェクトが名前空間に既に存在する場合は、 WaitHandleCannotBeOpenedException がスローされます。 それ以外の場合は、新しい同期オブジェクトが作成されます。

パラメーターに指定された名前のシステム イベントが既に name 存在する場合、 initialState パラメーターは無視されます。

注意事項

既定では、名前付きイベントは、そのイベントを作成したユーザーに限定されません。 他のユーザーは、イベントを不適切に設定またはリセットすることによってイベントを妨害するなど、イベントを開いて使用できる場合があります。 特定のユーザーへのアクセスを制限するには、コンストラクター オーバーロードを使用するか EventWaitHandleAcl 、名前付きイベントを作成するときに を EventWaitHandleSecurity 渡します。 信頼されていないユーザーがコードを実行している可能性があるシステムでは、アクセス制限なしで名前付きイベントを使用しないでください。

重要

名前付きシステム イベントにこのコンストラクターを使用する場合は、 に を指定 false します initialState。 このコンストラクターでは、名前付きシステム イベントが作成されたかどうかを判断する方法がないため、名前付きイベントの状態を想定することはできません。 名前付きイベントが作成されたかどうかを判断するには、コンストラクターまたは コンストラクターをEventWaitHandle(Boolean, EventResetMode, String, Boolean, EventWaitHandleSecurity)使用EventWaitHandle(Boolean, EventResetMode, String, Boolean)します。

イベントの初期状態が非署名の場合、イベントを待機するスレッドはブロックされます。 初期状態が通知され、 ManualReset フラグが に mode指定されている場合、イベントを待機するスレッドはブロックされません。 初期状態が 通知され、 が のAutoReset場合、modeイベントを待機する最初のスレッドが直ちに解放され、その後イベントがリセットされ、後続のスレッドがブロックされます。

こちらもご覧ください

• 同期プリミティブの概要

EventWaitHandle(Boolean, EventResetMode, String, Boolean)

ソース:

EventWaitHandle.cs

EventWaitHandle クラスの新しいインスタンスを初期化し、待機ハンドルがこの呼び出しの結果として作成された場合に最初にシグナル状態になるかどうか、リセットは自動または手動か、システムの同期イベントの名前、呼び出しの後の値で名前の付いたシステム イベントが作成されたかどうかを示すブール値変数を指定します。

C#

public EventWaitHandle (bool initialState, System.Threading.EventResetMode mode, string? name, out bool createdNew);

パラメーター

initialState

Boolean

名前の付いたイベントがこの呼び出しの結果として作成された場合に、初期状態をシグナル状態に設定するには true、非シグナル状態に設定するには false。

mode

EventResetMode

イベントが自動的にリセットされるかまたは手動でリセットされるかを指定する EventResetMode 値の 1 つ。

name

String

同期オブジェクトが他のプロセスと共有される場合は、名前。それ以外の場合は、null または空の文字列。 名前の大文字と小文字は区別されます。 円記号 (\) は予約されており、名前空間の指定にのみ使用できます。 名前空間の詳細については、「解説」セクションを参照してください。 オペレーティング システムによっては、名前にさらに制限がある場合があります。 たとえば、Unix ベースのオペレーティング システムでは、名前空間を除外した後の名前は有効なファイル名である必要があります。

createdNew

Boolean

このメソッドから制御が戻るときに、ローカル イベントが作成された場合 (name が true または空の文字列の場合)、または指定した名前付きシステム イベントが作成された場合は null が格納されます。指定した名前付きシステム イベントが既に存在する場合は false が格納されます。 このパラメーターは初期化せずに渡されます。

例外

IOException

name が無効です。 これは、不明なプレフィックスや無効な文字など、オペレーティング システムによって配置される可能性のある制限など、さまざまな理由で発生する可能性があります。 名前と共通プレフィックス "Global\" と "Local\" では大文字と小文字が区別されることに注意してください。

または

その他のエラーが発生しました。 HResult プロパティにさらに情報が含まれている場合があります。

DirectoryNotFoundException

Windows のみ: name により不明な名前空間が指定されました。 詳しくは、「オブジェクト名」をご覧ください。

PathTooLongException

name は長すぎます。 長さの制限は、オペレーティング システムまたは構成によって異なる場合があります。

UnauthorizedAccessException

アクセス制御セキュリティを使用した名前付きイベントが存在しますが、ユーザーに FullControl がありません。

WaitHandleCannotBeOpenedException

指定された name を持つ同期オブジェクトを作成できません。 別の型の同期オブジェクトに同じ名前が指定されている可能性があります。

ArgumentException

mode 列挙値が適正範囲外でした。

または

.NET Framework のみ: name MAX_PATH (260 文字) を超えています。

注釈

名前空間を name 指定するには、 の前 Global\ に または Local\ を付けます。 名前空間を Global 指定すると、同期オブジェクトをシステム上の任意のプロセスと共有できます。 名前空間が Local 指定されている場合(名前空間が指定されていない場合の既定値)、同期オブジェクトは同じセッション内のプロセスと共有される場合があります。 Windows では、セッションはログイン セッションであり、通常、サービスは別の非対話型セッションで実行されます。 Unix に似たオペレーティング システムでは、各シェルに独自のセッションがあります。 セッションローカル同期オブジェクトは、同じセッションで実行される親子関係を持つプロセス間の同期に適している場合があります。 Windows での同期オブジェクト名の詳細については、「 オブジェクト名」を参照してください。

nameが指定され、要求された型の同期オブジェクトが名前空間に既に存在する場合は、既存の同期オブジェクトが開かれます。 別の型の同期オブジェクトが名前空間に既に存在する場合は、 WaitHandleCannotBeOpenedException がスローされます。 それ以外の場合は、新しい同期オブジェクトが作成されます。

パラメーターに指定された名前のシステム イベントが既に name 存在する場合、 initialState パラメーターは無視されます。 このコンストラクターを呼び出した後、 パラメーター (ByRef Visual Basic のパラメーター)createdNew に指定されたref変数の値を使用して、名前付きシステム イベントが既に存在するか、作成されたかを判断します。

イベントの初期状態が未署名の場合、イベントを待機するスレッドはブロックされます。 初期状態がシグナル化され ManualReset 、 フラグが に mode指定されている場合、イベントを待機するスレッドはブロックされません。 初期状態が シグナル化され mode 、 が の AutoReset場合は、イベントを待機する最初のスレッドが直ちに解放され、その後イベントがリセットされ、後続のスレッドがブロックされます。

注意事項

既定では、名前付きイベントは、それを作成したユーザーに制限されません。 他のユーザーは、イベントを不適切に設定またはリセットすることによってイベントを妨害するなど、イベントを開いて使用できる場合があります。 特定のユーザーへのアクセスを制限するには、コンストラクターのオーバーロードを使用するか EventWaitHandleAcl 、名前付きイベントを作成するときに を EventWaitHandleSecurity 渡します。 信頼されていないユーザーがコードを実行している可能性があるシステムでは、アクセス制限なしで名前付きイベントを使用しないでください。

こちらもご覧ください

• 同期プリミティブの概要