WaitHandle.WaitAny メソッド

定義

名前空間:

System.Threading

アセンブリ:

System.Runtime.dll

指定した配列内のいずれかの要素がシグナルを受信するまで待機します。

オーバーロード

WaitAny(WaitHandle[])	指定した配列内のいずれかの要素がシグナルを受信するまで待機します。
WaitAny(WaitHandle[], Int32)	32 ビット符号付き整数を使用して時間間隔を指定し、指定した配列内のいずれかの要素がシグナルを受信するまで待機します。
WaitAny(WaitHandle[], TimeSpan)	TimeSpan を使用して時間間隔を指定し、指定した配列内のいずれかの要素がシグナルを受信するまで待機します。
WaitAny(WaitHandle[], Int32, Boolean)	32 ビットの符号付き整数を使用して時間間隔を指定し、待機する前に同期ドメインを終了するかどうかを指定して、指定した配列内のいずれかの要素がシグナルを受信するまで待機します。
WaitAny(WaitHandle[], TimeSpan, Boolean)	指定した配列内のいずれかの要素がシグナルを受信するまで待機します。TimeSpan を使用して時間間隔を指定し、待機の前でも同期ドメインを終了するかどうかを指定します。

WaitAny(WaitHandle[])

ソース:

WaitHandle.cs

指定した配列内のいずれかの要素がシグナルを受信するまで待機します。

C#

public static int WaitAny (System.Threading.WaitHandle[] waitHandles);

パラメーター

waitHandles

WaitHandle[]

現在のインスタンスが待機する対象のオブジェクトを格納している WaitHandle 配列。

戻り値

Int32

待機を実行するオブジェクトの配列インデックス。

例外

ArgumentNullException

waitHandles パラメーターが null です。

- または -

waitHandles 配列内の 1 つ以上のオブジェクトが null です。

NotSupportedException

waitHandles のオブジェクトの数が、システムで許可されている範囲を超えています。

ApplicationException

.NET Framework のバージョンが 1.0 または 1.1 であるにもかかわらず、waitHandles が要素のない配列です。

AbandonedMutexException

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。

ArgumentException

.NET Framework のバージョンが 2.0 以降であるにもかかわらず、waitHandles が要素のない配列です。

InvalidOperationException

waitHandles 配列には、別のアプリケーション ドメインのWaitHandle の透過プロキシが含まれます。

例

次のコード例では、 メソッドの呼び出しを WaitAny 示します。

C#

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 task is 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).

注釈

AbandonedMutexExceptionは、.NET Framework バージョン 2.0 の新機能です。 以前のバージョンでは、ミューテックスが WaitAny 破棄されたために待機が完了すると、 メソッドは を返 true します。 破棄されたミューテックスは、多くの場合、重大なコーディング エラーを示します。 システム全体のミューテックスの場合、アプリケーションが突然終了したことを示している可能性があります (たとえば、Windows タスク マネージャーを使用)。 例外には、デバッグに役立つ情報が含まれています。

メソッドは WaitAny 、 AbandonedMutexException ミューテックスが破棄されたために待機が完了したときにのみ をスローします。 破棄されたミューテックスよりもインデックス番号が小さい解放されたミューテックスが含まれている場合 waitHandles 、 WaitAny メソッドは正常に完了し、例外はスローされません。

注意

バージョン 2.0 より前のバージョンの.NET Frameworkでは、スレッドが を明示的に解放Mutexせずに終了または中止しMutex、別のスレッドの配列のWaitAnyインデックス 0 (ゼロ) にある場合、 によってWaitAny返されるインデックスは 0 ではなく 128 になります。

このメソッドは、任意のハンドルが通知されたときに を返します。 呼び出し中に複数のオブジェクトがシグナル化された場合、戻り値はシグナルオブジェクトの配列インデックスであり、すべてのシグナルオブジェクトの最小インデックス値を持ちます。

待機ハンドルの最大数は 64 で、現在のスレッドが状態の STA 場合は 63 です。

このメソッド オーバーロードの呼び出しは、 メソッド のオーバーロードを WaitAny(WaitHandle[], Int32, Boolean) 呼び出し、 および に対して -1 (または Timeout.Infinite) を millisecondsTimeouttrueexitContext指定することと同じです。

WaitAny(WaitHandle[], Int32)

ソース:

WaitHandle.cs

32 ビット符号付き整数を使用して時間間隔を指定し、指定した配列内のいずれかの要素がシグナルを受信するまで待機します。

C#

public static int WaitAny (System.Threading.WaitHandle[] waitHandles, int millisecondsTimeout);

パラメーター

waitHandles

WaitHandle[]

現在のインスタンスが待機する対象のオブジェクトを格納している WaitHandle 配列。

millisecondsTimeout

Int32

待機するミリ秒数。無制限に待機する場合は Infinite (-1)。

戻り値

Int32

待機を実行したオブジェクトの配列インデックス。または、待機を実行したオブジェクトがなく millisecondsTimeout に等しい時間間隔が経過した場合は WaitTimeout となります。

例外

ArgumentNullException

waitHandles パラメーターが null です。

- または -

waitHandles 配列内の 1 つ以上のオブジェクトが null です。

NotSupportedException

waitHandles のオブジェクトの数が、システムで許可されている範囲を超えています。

ArgumentOutOfRangeException

millisecondsTimeout は無限のタイムアウトを表す -1 以外の負の数です。

AbandonedMutexException

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。

ArgumentException

waitHandles は、要素を持たない配列です。

InvalidOperationException

waitHandles 配列には、別のアプリケーション ドメインのWaitHandle の透過プロキシが含まれます。

注釈

が 0 の場合 millisecondsTimeout 、メソッドはブロックしません。 待機ハンドルの状態をテストし、すぐに返します。

メソッドは WaitAny 、 AbandonedMutexException ミューテックスが破棄されたために待機が完了したときにのみ をスローします。 破棄されたミューテックスよりもインデックス番号が小さい解放されたミューテックスが含まれている場合 waitHandles 、 WaitAny メソッドは正常に完了し、例外はスローされません。

このメソッドは、いずれかのハンドルが通知されたとき、またはタイムアウトが発生したときに、待機が終了したときに を返します。 呼び出し中に複数のオブジェクトがシグナル化された場合、戻り値はシグナルオブジェクトの配列インデックスであり、すべてのシグナルオブジェクトの最小インデックス値を持ちます。

待機ハンドルの最大数は 64 で、現在のスレッドが状態の STA 場合は 63 です。

このメソッド オーバーロードの呼び出しは、 オーバーロードを呼び出し、 に WaitAny(WaitHandle[], Int32, Boolean) をexitContext指定するfalseのと同じです。

WaitAny(WaitHandle[], TimeSpan)

ソース:

WaitHandle.cs

TimeSpan を使用して時間間隔を指定し、指定した配列内のいずれかの要素がシグナルを受信するまで待機します。

C#

public static int WaitAny (System.Threading.WaitHandle[] waitHandles, TimeSpan timeout);

パラメーター

waitHandles

WaitHandle[]

現在のインスタンスが待機する対象のオブジェクトを格納している WaitHandle 配列。

timeout

TimeSpan

待機するミリ秒数を表す TimeSpan。無制限に待機する場合は、-1 ミリ秒を表す TimeSpan。

戻り値

Int32

待機を実行したオブジェクトの配列インデックス。または、待機を実行したオブジェクトがなく timeout に等しい時間間隔が経過した場合は WaitTimeout となります。

例外

ArgumentNullException

waitHandles パラメーターが null です。

- または -

waitHandles 配列内の 1 つ以上のオブジェクトが null です。

NotSupportedException

waitHandles のオブジェクトの数が、システムで許可されている範囲を超えています。

ArgumentOutOfRangeException

timeout は無限のタイムアウトを表す -1 ミリ秒以外の負の数です。

または

timeout が Int32.MaxValue より大きい。

AbandonedMutexException

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。

ArgumentException

waitHandles は、要素を持たない配列です。

InvalidOperationException

waitHandles 配列には、別のアプリケーション ドメインのWaitHandle の透過プロキシが含まれます。

注釈

が 0 の場合 timeout 、メソッドはブロックしません。 待機ハンドルの状態をテストし、すぐに返します。

メソッドは WaitAny 、 AbandonedMutexException ミューテックスが破棄されたために待機が完了したときにのみ をスローします。 破棄されたミューテックスよりもインデックス番号が小さい解放されたミューテックスが含まれている場合 waitHandles 、 WaitAny メソッドは正常に完了し、例外はスローされません。

このメソッドは、いずれかのハンドルがシグナル通知されたとき、またはタイムアウトが発生したときに、待機が終了したときに を返します。 呼び出し中に複数のオブジェクトがシグナル化された場合、戻り値はシグナルオブジェクトの配列インデックスであり、すべてのシグナルオブジェクトの最小インデックス値を持ちます。

待機ハンドルの最大数は 64 で、現在のスレッドが状態の STA 場合は 63 です。

の timeout 最大値は です Int32.MaxValue。

このメソッド オーバーロードの呼び出しは、 オーバーロードを呼び出し、 に WaitAny(WaitHandle[], TimeSpan, Boolean) をexitContext指定するfalseのと同じです。

WaitAny(WaitHandle[], Int32, Boolean)

ソース:

WaitHandle.cs

32 ビットの符号付き整数を使用して時間間隔を指定し、待機する前に同期ドメインを終了するかどうかを指定して、指定した配列内のいずれかの要素がシグナルを受信するまで待機します。

C#

public static int WaitAny (System.Threading.WaitHandle[] waitHandles, int millisecondsTimeout, bool exitContext);

パラメーター

waitHandles

WaitHandle[]

現在のインスタンスが待機する対象のオブジェクトを格納している WaitHandle 配列。

millisecondsTimeout

Int32

待機するミリ秒数。無制限に待機する場合は Infinite (-1)。

exitContext

Boolean

待機する前にコンテキストの同期ドメインを終了し (同期されたコンテキスト内にいる場合)、後で再取得する場合は、true。それ以外の場合は false。

戻り値

Int32

待機を実行したオブジェクトの配列インデックス。または、待機を実行したオブジェクトがなく millisecondsTimeout に等しい時間間隔が経過した場合は WaitTimeout となります。

例外

ArgumentNullException

waitHandles パラメーターが null です。

- または -

waitHandles 配列内の 1 つ以上のオブジェクトが null です。

NotSupportedException

waitHandles のオブジェクトの数が、システムで許可されている範囲を超えています。

ApplicationException

.NET Framework のバージョンが 1.0 または 1.1 であるにもかかわらず、waitHandles が要素のない配列です。

ArgumentOutOfRangeException

millisecondsTimeout は無限のタイムアウトを表す -1 以外の負の数です。

AbandonedMutexException

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。

ArgumentException

.NET Framework のバージョンが 2.0 以降であるにもかかわらず、waitHandles が要素のない配列です。

InvalidOperationException

waitHandles 配列には、別のアプリケーション ドメインのWaitHandle の透過プロキシが含まれます。

例

次のコード例では、スレッド プールを使用して複数のディスク上のファイルを同時に検索する方法を示します。 領域に関する考慮事項については、各ディスクのルート ディレクトリのみが検索されます。

C#

using System;
using System.IO;
using System.Threading;

class Test
{
    static void Main()
    {
        Search search = new Search();
        search.FindFile("SomeFile.dat");
    }
}

class Search
{
    // Maintain state information to pass to FindCallback.
    class State
    {
        public AutoResetEvent autoEvent;
        public string         fileName;

        public State(AutoResetEvent autoEvent, string fileName)
        {
            this.autoEvent    = autoEvent;
            this.fileName     = fileName;
        }
    }

    AutoResetEvent[] autoEvents;
    String[] diskLetters;

    public Search()
    {
        // Retrieve an array of disk letters.
        diskLetters = Environment.GetLogicalDrives();

        autoEvents = new AutoResetEvent[diskLetters.Length];
        for(int i = 0; i < diskLetters.Length; i++)
        {
            autoEvents[i] = new AutoResetEvent(false);
        }
    }

    // Search for fileName in the root directory of all disks.
    public void FindFile(string fileName)
    {
        for(int i = 0; i < diskLetters.Length; i++)
        {
            Console.WriteLine("Searching for {0} on {1}.",
                fileName, diskLetters[i]);
            ThreadPool.QueueUserWorkItem(
                new WaitCallback(FindCallback), 
                new State(autoEvents[i], diskLetters[i] + fileName));
        }

        // Wait for the first instance of the file to be found.
        int index = WaitHandle.WaitAny(autoEvents, 3000, false);
        if(index == WaitHandle.WaitTimeout)
        {
            Console.WriteLine("\n{0} not found.", fileName);
        }
        else
        {
            Console.WriteLine("\n{0} found on {1}.", fileName,
                diskLetters[index]);
        }
    }

    // Search for stateInfo.fileName.
    void FindCallback(object state)
    {
        State stateInfo = (State)state;

        // Signal if the file is found.
        if(File.Exists(stateInfo.fileName))
        {
            stateInfo.autoEvent.Set();
        }
    }
}

注釈

が 0 の場合 millisecondsTimeout 、メソッドはブロックしません。 待機ハンドルの状態をテストし、すぐに返します。

メソッドは WaitAny 、 AbandonedMutexException ミューテックスが破棄されたために待機が完了したときにのみ をスローします。 破棄されたミューテックスよりもインデックス番号が小さい解放されたミューテックスが含まれている場合 waitHandles 、 WaitAny メソッドは正常に完了し、例外はスローされません。 破棄されたミューテックスは、多くの場合、重大なコーディング エラーを示します。 システム全体のミューテックスの場合、アプリケーションが突然終了したことを示している可能性があります (たとえば、Windows タスク マネージャーを使用)。 例外には、デバッグに役立つ情報が含まれています。

このメソッドは、いずれかのハンドルが通知されたとき、またはタイムアウトが発生したときに、待機が終了したときに を返します。 呼び出し中に複数のオブジェクトがシグナル化された場合、戻り値はシグナルオブジェクトの配列インデックスであり、すべてのシグナルオブジェクトの最小インデックス値を持ちます。

待機ハンドルの最大数は 64 で、現在のスレッドが状態の STA 場合は 63 です。

コンテキストの終了

パラメーターは、既定以外の exitContext マネージド コンテキスト内からこのメソッドが呼び出されない限り、効果はありません。 スレッドが から ContextBoundObject派生したクラスのインスタンスの呼び出し内にある場合、マネージド コンテキストは既定以外の場合があります。 などString、 からContextBoundObject派生していないクラスでメソッドを現在実行している場合でも、 が現在のアプリケーション ドメイン内のスタック上にある場合ContextBoundObjectは、既定以外のコンテキストに存在できます。

コードが既定以外のコンテキストで実行されている場合、 をtrueexitContext指定すると、このメソッドを実行する前に、スレッドは既定以外のマネージド コンテキスト (つまり、既定のコンテキストに移行) を終了します。 このメソッドの呼び出しが完了すると、スレッドは元の既定以外のコンテキストに戻ります。

コンテキストを終了すると、コンテキスト バインド クラスに 属性がある場合に SynchronizationAttribute 便利です。 その場合、クラスのメンバーに対するすべての呼び出しが自動的に同期され、同期ドメインはクラスのコード本文全体になります。 メンバーの呼び出し履歴内のコードがこのメソッドを呼び出し、 に をexitContext指定trueすると、スレッドは同期ドメインを終了します。これにより、オブジェクトの任意のメンバーへの呼び出しでブロックされているスレッドを続行できます。 このメソッドが戻るときに、呼び出しを行ったスレッドは、同期ドメインの再入力を待機する必要があります。

WaitAny(WaitHandle[], TimeSpan, Boolean)

ソース:

WaitHandle.cs

指定した配列内のいずれかの要素がシグナルを受信するまで待機します。TimeSpan を使用して時間間隔を指定し、待機の前でも同期ドメインを終了するかどうかを指定します。

C#

public static int WaitAny (System.Threading.WaitHandle[] waitHandles, TimeSpan timeout, bool exitContext);

パラメーター

waitHandles

WaitHandle[]

現在のインスタンスが待機する対象のオブジェクトを格納している WaitHandle 配列。

timeout

TimeSpan

待機するミリ秒数を表す TimeSpan。無制限に待機する場合は、-1 ミリ秒を表す TimeSpan。

exitContext

Boolean

待機する前にコンテキストの同期ドメインを終了し (同期されたコンテキスト内にいる場合)、後で再取得する場合は、true。それ以外の場合は false。

戻り値

Int32

待機を実行したオブジェクトの配列インデックス。または、待機を実行したオブジェクトがなく timeout に等しい時間間隔が経過した場合は WaitTimeout となります。

例外

ArgumentNullException

waitHandles パラメーターが null です。

- または -

waitHandles 配列内の 1 つ以上のオブジェクトが null です。

NotSupportedException

waitHandles のオブジェクトの数が、システムで許可されている範囲を超えています。

ApplicationException

.NET Framework のバージョンが 1.0 または 1.1 であるにもかかわらず、waitHandles が要素のない配列です。

ArgumentOutOfRangeException

timeout は無限のタイムアウトを表す -1 ミリ秒以外の負の数です。

または

timeout が Int32.MaxValue より大きい。

AbandonedMutexException

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。

ArgumentException

.NET Framework のバージョンが 2.0 以降であるにもかかわらず、waitHandles が要素のない配列です。

InvalidOperationException

waitHandles 配列には、別のアプリケーション ドメインのWaitHandle の透過プロキシが含まれます。

例

次のコード例では、スレッド プールを使用して複数のディスク上のファイルを同時に検索する方法を示します。 領域に関する考慮事項については、各ディスクのルート ディレクトリのみが検索されます。

C#

using System;
using System.IO;
using System.Threading;

class Test
{
    static void Main()
    {
        Search search = new Search();
        search.FindFile("SomeFile.dat");
    }
}

class Search
{
    // Maintain state information to pass to FindCallback.
    class State
    {
        public AutoResetEvent autoEvent;
        public string         fileName;

        public State(AutoResetEvent autoEvent, string fileName)
        {
            this.autoEvent    = autoEvent;
            this.fileName     = fileName;
        }
    }

    AutoResetEvent[] autoEvents;
    String[] diskLetters;

    public Search()
    {
        // Retrieve an array of disk letters.
        diskLetters = Environment.GetLogicalDrives();

        autoEvents = new AutoResetEvent[diskLetters.Length];
        for(int i = 0; i < diskLetters.Length; i++)
        {
            autoEvents[i] = new AutoResetEvent(false);
        }
    }

    // Search for fileName in the root directory of all disks.
    public void FindFile(string fileName)
    {
        for(int i = 0; i < diskLetters.Length; i++)
        {
            Console.WriteLine("Searching for {0} on {1}.",
                fileName, diskLetters[i]);
            ThreadPool.QueueUserWorkItem(
                new WaitCallback(FindCallback), 
                new State(autoEvents[i], diskLetters[i] + fileName));
        }

        // Wait for the first instance of the file to be found.
        int index = WaitHandle.WaitAny(
            autoEvents, new TimeSpan(0, 0, 3), false);
        if(index == WaitHandle.WaitTimeout)
        {
            Console.WriteLine("\n{0} not found.", fileName);
        }
        else
        {
            Console.WriteLine("\n{0} found on {1}.", fileName,
                diskLetters[index]);
        }
    }

    // Search for stateInfo.fileName.
    void FindCallback(object state)
    {
        State stateInfo = (State)state;

        // Signal if the file is found.
        if(File.Exists(stateInfo.fileName))
        {
            stateInfo.autoEvent.Set();
        }
    }
}

注釈

が 0 の場合 timeout 、メソッドはブロックしません。 待機ハンドルの状態をテストし、すぐに返します。

メソッドは WaitAny 、 AbandonedMutexException ミューテックスが破棄されたために待機が完了したときにのみ をスローします。 破棄されたミューテックスよりもインデックス番号が小さい解放されたミューテックスが含まれている場合 waitHandles 、 WaitAny メソッドは正常に完了し、例外はスローされません。 破棄されたミューテックスは、多くの場合、重大なコーディング エラーを示します。 システム全体のミューテックスの場合、アプリケーションが突然終了したことを示している可能性があります (たとえば、Windows タスク マネージャーを使用)。 例外には、デバッグに役立つ情報が含まれています。

このメソッドは、いずれかのハンドルがシグナル通知されたとき、またはタイムアウトが発生したときに、待機が終了したときに を返します。 呼び出し中に複数のオブジェクトがシグナル化された場合、戻り値はシグナルオブジェクトの配列インデックスであり、すべてのシグナルオブジェクトの最小インデックス値を持ちます。

待機ハンドルの最大数は 64 で、現在のスレッドが状態の STA 場合は 63 です。

の timeout 最大値は です Int32.MaxValue。

コンテキストの終了

パラメーターは、既定以外の exitContext マネージド コンテキスト内からこのメソッドが呼び出されない限り、効果はありません。 スレッドが から ContextBoundObject派生したクラスのインスタンスの呼び出し内にある場合、マネージド コンテキストは既定以外の場合があります。 などString、 からContextBoundObject派生していないクラスでメソッドを現在実行している場合でも、 が現在のアプリケーション ドメイン内のスタック上にある場合ContextBoundObjectは、既定以外のコンテキストに存在できます。

コードが既定以外のコンテキストで実行されている場合、 をtrueexitContext指定すると、このメソッドを実行する前に、スレッドは既定以外のマネージド コンテキスト (つまり、既定のコンテキストに移行) を終了します。 このメソッドの呼び出しが完了すると、スレッドは元の既定以外のコンテキストに戻ります。

コンテキストを終了すると、コンテキスト バインド クラスに 属性がある場合に SynchronizationAttribute 便利です。 その場合、クラスのメンバーに対するすべての呼び出しが自動的に同期され、同期ドメインはクラスのコード本文全体になります。 メンバーの呼び出し履歴内のコードがこのメソッドを呼び出し、 に をexitContext指定trueすると、スレッドは同期ドメインを終了します。これにより、オブジェクトの任意のメンバーへの呼び出しでブロックされているスレッドを続行できます。 このメソッドが戻るときに、呼び出しを行ったスレッドは、同期ドメインの再入力を待機する必要があります。