WaitHandle.WaitOne メソッド

定義

現在の WaitHandle がシグナルを受け取るまで、現在のスレッドをブロックします。Blocks the current thread until the current WaitHandle receives a signal.

オーバーロード

WaitOne()

現在の WaitHandle がシグナルを受け取るまで、現在のスレッドをブロックします。Blocks the current thread until the current WaitHandle receives a signal.

WaitOne(Int32)

32 ビット符号付き整数を使用して時間間隔をミリ秒単位で指定し、現在の WaitHandle がシグナルを受信するまで、現在のスレッドをブロックします。Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval in milliseconds.

WaitOne(TimeSpan)

TimeSpan を使用して時間間隔を指定し、現在のインスタンスがシグナルを受信するまで現在のスレッドをブロックします。Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval.

WaitOne(Int32, Boolean)

現在の WaitHandle がシグナルを受信するまで現在のスレッドをブロックします。時間間隔を指定するために 32 ビット符号付き整数を使用し、待機の前でも同期ドメインを終了するかどうかを指定します。Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval and specifying whether to exit the synchronization domain before the wait.

WaitOne(TimeSpan, Boolean)

現在のインスタンスがシグナルを受信するまで現在のスレッドをブロックします。TimeSpan を使用して時間間隔を指定し、待機の前でも同期ドメインを終了するかどうかを指定します。Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval and specifying whether to exit the synchronization domain before the wait.

WaitOne()

現在の WaitHandle がシグナルを受け取るまで、現在のスレッドをブロックします。Blocks the current thread until the current WaitHandle receives a signal.

public:
 virtual bool WaitOne();
public virtual bool WaitOne ();
abstract member WaitOne : unit -> bool
override this.WaitOne : unit -> bool
Public Overridable Function WaitOne () As Boolean

戻り値

現在のインスタンスがシグナルを受け取った場合は truetrue if the current instance receives a signal. 現在のインスタンスがシグナルを受け取らない場合は、WaitOne(Int32, Boolean) はシグナルを受け取るまで待機を続けます。If the current instance is never signaled, WaitOne(Int32, Boolean) never returns.

例外

現在のインスタンスは既に破棄されています。The current instance has already been disposed.

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。The wait completed because a thread exited without releasing a mutex. Windows 98 または Windows Millennium Edition では、この例外はスローされません。This exception is not thrown on Windows 98 or Windows Millennium Edition.

別のアプリケーション ドメインでは、現在のインスタンスは WaitHandle の透過プロキシです。The current instance is a transparent proxy for a WaitHandle in another application domain.

次のコード例は、待機ハンドルを使用して、バックグラウンドスレッドの実行が完了するのを待機している間にプロセスを終了しないようにする方法を示しています。The following code example shows how to use a wait handle to keep a process from terminating while it waits for a background thread to finish executing.

using namespace System;
using namespace System::Threading;
ref class WaitOne
{
private:
   WaitOne(){}


public:
   static void WorkMethod( Object^ stateInfo )
   {
      Console::WriteLine( "Work starting." );
      
      // Simulate time spent working.
      Thread::Sleep( (gcnew Random)->Next( 100, 2000 ) );
      
      // Signal that work is finished.
      Console::WriteLine( "Work ending." );
      dynamic_cast<AutoResetEvent^>(stateInfo)->Set();
   }

};

int main()
{
   Console::WriteLine( "Main starting." );
   AutoResetEvent^ autoEvent = gcnew AutoResetEvent( false );
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( &WaitOne::WorkMethod ), autoEvent );
   
   // Wait for work method to signal.
   autoEvent->WaitOne(  );
   Console::WriteLine( "Work method signaled.\nMain ending." );
}

using System;
using System.Threading;

class WaitOne
{
    static AutoResetEvent autoEvent = new AutoResetEvent(false);

    static void Main()
    {
        Console.WriteLine("Main starting.");

        ThreadPool.QueueUserWorkItem(
            new WaitCallback(WorkMethod), autoEvent);

        // Wait for work method to signal.
        autoEvent.WaitOne();
        Console.WriteLine("Work method signaled.\nMain ending.");
    }

    static void WorkMethod(object stateInfo) 
    {
        Console.WriteLine("Work starting.");

        // Simulate time spent working.
        Thread.Sleep(new Random().Next(100, 2000));

        // Signal that work is finished.
        Console.WriteLine("Work ending.");
        ((AutoResetEvent)stateInfo).Set();
    }
}
Imports System.Threading

Public Class WaitOne

    Shared autoEvent As New AutoResetEvent(False)

    <MTAThread> _
    Shared Sub Main()
        Console.WriteLine("Main starting.")

        ThreadPool.QueueUserWorkItem(AddressOf WorkMethod, autoEvent)

        ' Wait for work method to signal.
        autoEvent.WaitOne()
        Console.WriteLine("Work method signaled.")
        Console.WriteLine("Main ending.")
    End Sub

    Shared Sub WorkMethod(stateInfo As Object) 
        Console.WriteLine("Work starting.")

        ' Simulate time spent working.
        Thread.Sleep(New Random().Next(100, 2000))

        ' Signal that work is finished.
        Console.WriteLine("Work ending.")
        CType(stateInfo, AutoResetEvent).Set()
    End Sub

End Class

注釈

AbandonedMutexException は .NET Framework バージョン2.0 で新しく追加されたものです。AbandonedMutexException is new in the .NET Framework version 2.0. 以前のバージョンでは、ミューテックスが破棄されると、WaitOne メソッドは true を返します。In previous versions, the WaitOne method returns true when a mutex is abandoned. 多くの場合、放棄ミューテックスは深刻なコーディングエラーを示しています。An abandoned mutex often indicates a serious coding error. システム全体のミューテックスの場合は、アプリケーションが突然 (たとえば、Windows タスクマネージャーを使用して) 終了したことを示している可能性があります。In the case of a system-wide mutex, it might indicate that an application has been terminated abruptly (for example, by using Windows Task Manager). 例外には、デバッグに役立つ情報が含まれています。The exception contains information useful for debugging.

このメソッドの呼び出し元は、現在のインスタンスがシグナルを受信するまで無期限にブロックされます。The caller of this method blocks indefinitely until the current instance receives a signal. このメソッドは、非同期操作の完了時にが生成されるなど、WaitHandle が別のスレッドからのシグナルを受信するまでブロックするために使用します。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 詳細については、IAsyncResult インターフェイスのトピックを参照してください。For more information, see the IAsyncResult interface.

このメソッドのオーバーロードを呼び出すことは、WaitOne(Int32, Boolean) メソッドオーバーロードを呼び出し、最初のパラメーターに-1 または Timeout.Infinite を指定し、2番目のパラメーターに false を指定することと同じです。Calling this method overload is equivalent to calling the WaitOne(Int32, Boolean) method overload and specifying -1 or Timeout.Infinite for the first parameter and false for the second parameter.

派生クラスの動作をカスタマイズするには、このメソッドをオーバーライドします。Override this method to customize the behavior of derived classes.

WaitOne(Int32)

32 ビット符号付き整数を使用して時間間隔をミリ秒単位で指定し、現在の WaitHandle がシグナルを受信するまで、現在のスレッドをブロックします。Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval in milliseconds.

public:
 virtual bool WaitOne(int millisecondsTimeout);
public virtual bool WaitOne (int millisecondsTimeout);
abstract member WaitOne : int -> bool
override this.WaitOne : int -> bool
Public Overridable Function WaitOne (millisecondsTimeout As Integer) As Boolean

パラメーター

millisecondsTimeout
Int32

待機するミリ秒数。無制限に待機する場合は Infinite (-1)。The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

戻り値

現在のインスタンスがシグナルを受け取る場合は true。それ以外の場合は falsetrue if the current instance receives a signal; otherwise, false.

例外

現在のインスタンスは既に破棄されています。The current instance has already been disposed.

millisecondsTimeout は無限のタイムアウトを表す -1 以外の負の数です。millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。The wait completed because a thread exited without releasing a mutex. Windows 98 または Windows Millennium Edition では、この例外はスローされません。This exception is not thrown on Windows 98 or Windows Millennium Edition.

別のアプリケーション ドメインでは、現在のインスタンスは WaitHandle の透過プロキシです。The current instance is a transparent proxy for a WaitHandle in another application domain.

次のコード例は、待機ハンドルを使用して、バックグラウンドスレッドの実行が完了するのを待機している間にプロセスを終了しないようにする方法を示しています。The following code example shows how to use a wait handle to keep a process from terminating while it waits for a background thread to finish executing.

using namespace System;
using namespace System::Threading;
ref class WaitOne
{
private:
   WaitOne(){}


public:
   static void WorkMethod( Object^ stateInfo )
   {
      Console::WriteLine( "Work starting." );
      
      // Simulate time spent working.
      Thread::Sleep( (gcnew Random)->Next( 100, 2000 ) );
      
      // Signal that work is finished.
      Console::WriteLine( "Work ending." );
      dynamic_cast<AutoResetEvent^>(stateInfo)->Set();
   }

};

int main()
{
   Console::WriteLine( "Main starting." );
   AutoResetEvent^ autoEvent = gcnew AutoResetEvent( false );
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( &WaitOne::WorkMethod ), autoEvent );
   
   // Wait for work method to signal.
   if ( autoEvent->WaitOne( 1000 ) )
   {
      Console::WriteLine( "Work method signaled." );
   }
   else
   {
      Console::WriteLine( "Timed out waiting for work "
      "method to signal." );
   }

   Console::WriteLine( "Main ending." );
}

using System;
using System.Threading;

class WaitOne
{
    static AutoResetEvent autoEvent = new AutoResetEvent(false);

    static void Main()
    {
        Console.WriteLine("Main starting.");

        ThreadPool.QueueUserWorkItem(
            new WaitCallback(WorkMethod), autoEvent);

        // Wait for work method to signal.
        if(autoEvent.WaitOne(1000))
        {
            Console.WriteLine("Work method signaled.");
        }
        else
        {
            Console.WriteLine("Timed out waiting for work " +
                "method to signal.");
        }
        Console.WriteLine("Main ending.");
    }

    static void WorkMethod(object stateInfo) 
    {
        Console.WriteLine("Work starting.");

        // Simulate time spent working.
        Thread.Sleep(new Random().Next(100, 2000));

        // Signal that work is finished.
        Console.WriteLine("Work ending.");
        ((AutoResetEvent)stateInfo).Set();
    }
}
Imports System.Threading

Public Class WaitOne

    Shared autoEvent As New AutoResetEvent(False)

    <MTAThread> _
    Shared Sub Main()
        Console.WriteLine("Main starting.")

        ThreadPool.QueueUserWorkItem(AddressOf WorkMethod, autoEvent)

        ' Wait for work method to signal.
        If autoEvent.WaitOne(1000) Then
            Console.WriteLine("Work method signaled.")
        Else
            Console.WriteLine("Timed out waiting for work " & _
                "method to signal.")
        End If

        Console.WriteLine("Main ending.")
    End Sub

    Shared Sub WorkMethod(stateInfo As Object) 
        Console.WriteLine("Work starting.")

        ' Simulate time spent working.
        Thread.Sleep(New Random().Next(100, 2000))

        ' Signal that work is finished.
        Console.WriteLine("Work ending.")
        CType(stateInfo, AutoResetEvent).Set()
    End Sub

End Class

注釈

@No__t-0 が0の場合、メソッドはブロックしません。If millisecondsTimeout is zero, the method does not block. 待機ハンドルの状態をテストし、すぐに制御を戻します。It tests the state of the wait handle and returns immediately.

このメソッドの呼び出し元は、現在のインスタンスがシグナルを受信するか、タイムアウトが発生するまでブロックします。The caller of this method blocks until the current instance receives a signal or a time-out occurs. このメソッドは、非同期操作の完了時にが生成されるなど、WaitHandle が別のスレッドからのシグナルを受信するまでブロックするために使用します。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 詳細については、IAsyncResult インターフェイスのトピックを参照してください。For more information, see the IAsyncResult interface.

派生クラスの動作をカスタマイズするには、このメソッドをオーバーライドします。Override this method to customize the behavior of derived classes.

このメソッドのオーバーロードを呼び出すことは、@no__t 0 のオーバーロードを呼び出し、exitContextfalse を指定することと同じです。Calling this method overload is the same as calling the WaitOne(Int32, Boolean) overload and specifying false for exitContext.

WaitOne(TimeSpan)

TimeSpan を使用して時間間隔を指定し、現在のインスタンスがシグナルを受信するまで現在のスレッドをブロックします。Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval.

public:
 virtual bool WaitOne(TimeSpan timeout);
public virtual bool WaitOne (TimeSpan timeout);
abstract member WaitOne : TimeSpan -> bool
override this.WaitOne : TimeSpan -> bool
Public Overridable Function WaitOne (timeout As TimeSpan) As Boolean

パラメーター

timeout
TimeSpan

待機するミリ秒数を表す TimeSpan。無制限に待機する場合は、-1 ミリ秒を表す TimeSpanA TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

戻り値

現在のインスタンスがシグナルを受け取る場合は true。それ以外の場合は falsetrue if the current instance receives a signal; otherwise, false.

例外

現在のインスタンスは既に破棄されています。The current instance has already been disposed.

timeout は無限のタイムアウトを表す -1 ミリ秒以外の負の数です。timeout is a negative number other than -1 milliseconds, which represents an infinite time-out. - または --or- timeoutMaxValue より大きくなっています。timeout is greater than MaxValue.

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。The wait completed because a thread exited without releasing a mutex. Windows 98 または Windows Millennium Edition では、この例外はスローされません。This exception is not thrown on Windows 98 or Windows Millennium Edition.

別のアプリケーション ドメインでは、現在のインスタンスは WaitHandle の透過プロキシです。The current instance is a transparent proxy for a WaitHandle in another application domain.

注釈

@No__t-0 が0の場合、メソッドはブロックしません。If timeout is zero, the method does not block. 待機ハンドルの状態をテストし、すぐに制御を戻します。It tests the state of the wait handle and returns immediately.

このメソッドの呼び出し元は、現在のインスタンスがシグナルを受信するか、タイムアウトが発生するまでブロックします。The caller of this method blocks until the current instance receives a signal or a time-out occurs. このメソッドは、非同期操作の完了時にが生成されるなど、WaitHandle が別のスレッドからのシグナルを受信するまでブロックするために使用します。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 詳細については、IAsyncResult インターフェイスのトピックを参照してください。For more information, see the IAsyncResult interface.

派生クラスの動作をカスタマイズするには、このメソッドをオーバーライドします。Override this method to customize the behavior of derived classes.

@No__t-0 の最大値は Int32.MaxValue です。The maximum value for timeout is Int32.MaxValue.

このメソッドのオーバーロードを呼び出すことは、@no__t 0 のオーバーロードを呼び出し、exitContextfalse を指定することと同じです。Calling this method overload is the same as calling the WaitOne(TimeSpan, Boolean) overload and specifying false for exitContext.

WaitOne(Int32, Boolean)

現在の WaitHandle がシグナルを受信するまで現在のスレッドをブロックします。時間間隔を指定するために 32 ビット符号付き整数を使用し、待機の前でも同期ドメインを終了するかどうかを指定します。Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval and specifying whether to exit the synchronization domain before the wait.

public:
 virtual bool WaitOne(int millisecondsTimeout, bool exitContext);
public virtual bool WaitOne (int millisecondsTimeout, bool exitContext);
abstract member WaitOne : int * bool -> bool
override this.WaitOne : int * bool -> bool
Public Overridable Function WaitOne (millisecondsTimeout As Integer, exitContext As Boolean) As Boolean

パラメーター

millisecondsTimeout
Int32

待機するミリ秒数。無制限に待機する場合は Infinite (-1)。The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

exitContext
Boolean

待機する前にコンテキストの同期ドメインを終了し (同期されたコンテキスト内にいる場合)、後で再取得する場合は、true。それ以外の場合は falsetrue to exit the synchronization domain for the context before the wait (if in a synchronized context), and reacquire it afterward; otherwise, false.

戻り値

現在のインスタンスがシグナルを受け取る場合は true。それ以外の場合は falsetrue if the current instance receives a signal; otherwise, false.

例外

現在のインスタンスは既に破棄されています。The current instance has already been disposed.

millisecondsTimeout は無限のタイムアウトを表す -1 以外の負の数です。millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。The wait completed because a thread exited without releasing a mutex. Windows 98 または Windows Millennium Edition では、この例外はスローされません。This exception is not thrown on Windows 98 or Windows Millennium Edition.

別のアプリケーション ドメインでは、現在のインスタンスは WaitHandle の透過プロキシです。The current instance is a transparent proxy for a WaitHandle in another application domain.

次の例では、同期ドメイン内で呼び出されたときに、WaitOne(Int32, Boolean) メソッドのオーバーロードがどのように動作するかを示します。The following example shows how the WaitOne(Int32, Boolean) method overload behaves when it is called within a synchronization domain. まず、スレッドは exitContext が @no__t に設定された状態で待機し、待機タイムアウトが経過するまでブロックします。First, a thread waits with exitContext set to false and blocks until the wait timeout expires. 2番目のスレッドは、最初のスレッドが終了した後に実行され、exitContexttrue に設定された状態で待機します。A second thread executes after the first thread terminates and waits with exitContext set to true. この2番目のスレッドの待機ハンドルを通知する呼び出しはブロックされず、スレッドは待機タイムアウト前に完了します。The call to signal the wait handle for this second thread is not blocked, and the thread completes before the wait timeout.

using namespace System;
using namespace System::Threading;
using namespace System::Runtime::Remoting::Contexts;

[Synchronization(true)]
public ref class SyncingClass : ContextBoundObject
{
private:
    EventWaitHandle^ waitHandle;

public:
    SyncingClass()
    {
         waitHandle =
            gcnew EventWaitHandle(false, EventResetMode::ManualReset);
    }

    void Signal()
    {
        Console::WriteLine("Thread[{0:d4}]: Signalling...", Thread::CurrentThread->GetHashCode());
        waitHandle->Set();
    }

    void DoWait(bool leaveContext)
    {
        bool signalled;

        waitHandle->Reset();
        Console::WriteLine("Thread[{0:d4}]: Waiting...", Thread::CurrentThread->GetHashCode());
        signalled = waitHandle->WaitOne(3000, leaveContext);
        if (signalled)
        {
            Console::WriteLine("Thread[{0:d4}]: Wait released!!!", Thread::CurrentThread->GetHashCode());
        }
        else
        {
            Console::WriteLine("Thread[{0:d4}]: Wait timeout!!!", Thread::CurrentThread->GetHashCode());
        }
    }
};

public ref class TestSyncDomainWait
{
public:
    static void Main()
    {
        SyncingClass^ syncClass = gcnew SyncingClass();

        Thread^ runWaiter;

        Console::WriteLine("\nWait and signal INSIDE synchronization domain:\n");
        runWaiter = gcnew Thread(gcnew ParameterizedThreadStart(&TestSyncDomainWait::RunWaitKeepContext));
        runWaiter->Start(syncClass);
        Thread::Sleep(1000);
        Console::WriteLine("Thread[{0:d4}]: Signal...", Thread::CurrentThread->GetHashCode());
        // This call to Signal will block until the timeout in DoWait expires.
        syncClass->Signal();
        runWaiter->Join();

        Console::WriteLine("\nWait and signal OUTSIDE synchronization domain:\n");
        runWaiter = gcnew Thread(gcnew ParameterizedThreadStart(&TestSyncDomainWait::RunWaitLeaveContext));
        runWaiter->Start(syncClass);
        Thread::Sleep(1000);
        Console::WriteLine("Thread[{0:d4}]: Signal...", Thread::CurrentThread->GetHashCode());
        // This call to Signal is unblocked and will set the wait handle to
        // release the waiting thread.
        syncClass->Signal();
        runWaiter->Join();
    }

    static void RunWaitKeepContext(Object^ parm)
    {
        ((SyncingClass^)parm)->DoWait(false);
    }

    static void RunWaitLeaveContext(Object^ parm)
    {
        ((SyncingClass^)parm)->DoWait(true);
    }
};

int main()
{
    TestSyncDomainWait::Main();
}
// The output for the example program will be similar to the following:
//
// Wait and signal INSIDE synchronization domain:
//
// Thread[0004]: Waiting...
// Thread[0001]: Signal...
// Thread[0004]: Wait timeout!!!
// Thread[0001]: Signalling...
//
// Wait and signal OUTSIDE synchronization domain:
//
// Thread[0006]: Waiting...
// Thread[0001]: Signal...
// Thread[0001]: Signalling...
// Thread[0006]: Wait released!!!
using System;
using System.Threading;
using System.Runtime.Remoting.Contexts;

[Synchronization(true)]
public class SyncingClass : ContextBoundObject
{
    private EventWaitHandle waitHandle;

    public SyncingClass()
    {
         waitHandle =
            new EventWaitHandle(false, EventResetMode.ManualReset);
    }

    public void Signal()
    {
        Console.WriteLine("Thread[{0:d4}]: Signalling...", Thread.CurrentThread.GetHashCode());
        waitHandle.Set();
    }

    public void DoWait(bool leaveContext)
    {
        bool signalled;

        waitHandle.Reset();
        Console.WriteLine("Thread[{0:d4}]: Waiting...", Thread.CurrentThread.GetHashCode());
        signalled = waitHandle.WaitOne(3000, leaveContext);
        if (signalled)
        {
            Console.WriteLine("Thread[{0:d4}]: Wait released!!!", Thread.CurrentThread.GetHashCode());
        }
        else
        {
            Console.WriteLine("Thread[{0:d4}]: Wait timeout!!!", Thread.CurrentThread.GetHashCode());
        }
    }
}

public class TestSyncDomainWait
{
    public static void Main()
    {
        SyncingClass syncClass = new SyncingClass();

        Thread runWaiter;

        Console.WriteLine("\nWait and signal INSIDE synchronization domain:\n");
        runWaiter = new Thread(RunWaitKeepContext);
        runWaiter.Start(syncClass);
        Thread.Sleep(1000);
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode());
        // This call to Signal will block until the timeout in DoWait expires.
        syncClass.Signal();
        runWaiter.Join();

        Console.WriteLine("\nWait and signal OUTSIDE synchronization domain:\n");
        runWaiter = new Thread(RunWaitLeaveContext);
        runWaiter.Start(syncClass);
        Thread.Sleep(1000);
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode());
        // This call to Signal is unblocked and will set the wait handle to
        // release the waiting thread.
        syncClass.Signal();
        runWaiter.Join();
    }

    public static void RunWaitKeepContext(object parm)
    {
        ((SyncingClass)parm).DoWait(false);
    }

    public static void RunWaitLeaveContext(object parm)
    {
        ((SyncingClass)parm).DoWait(true);
    }
}

// The output for the example program will be similar to the following:
//
// Wait and signal INSIDE synchronization domain:
//
// Thread[0004]: Waiting...
// Thread[0001]: Signal...
// Thread[0004]: Wait timeout!!!
// Thread[0001]: Signalling...
//
// Wait and signal OUTSIDE synchronization domain:
//
// Thread[0006]: Waiting...
// Thread[0001]: Signal...
// Thread[0001]: Signalling...
// Thread[0006]: Wait released!!!
Imports System.Threading
Imports System.Runtime.Remoting.Contexts

<Synchronization(true)>
Public Class SyncingClass
    Inherits ContextBoundObject
    
    Private waitHandle As EventWaitHandle

    Public Sub New()
         waitHandle = New EventWaitHandle(false, EventResetMode.ManualReset)
    End Sub

    Public Sub Signal()
        Console.WriteLine("Thread[{0:d4}]: Signalling...", Thread.CurrentThread.GetHashCode())
        waitHandle.Set()
    End Sub

    Public Sub DoWait(leaveContext As Boolean)
        Dim signalled As Boolean

        waitHandle.Reset()
        Console.WriteLine("Thread[{0:d4}]: Waiting...", Thread.CurrentThread.GetHashCode())
        signalled = waitHandle.WaitOne(3000, leaveContext)
        If signalled Then
            Console.WriteLine("Thread[{0:d4}]: Wait released!!!", Thread.CurrentThread.GetHashCode())
        Else
            Console.WriteLine("Thread[{0:d4}]: Wait timeout!!!", Thread.CurrentThread.GetHashCode())
        End If
    End Sub
End Class

Public Class TestSyncDomainWait
    Public Shared Sub Main()
        Dim syncClass As New SyncingClass()

        Dim runWaiter As Thread

        Console.WriteLine(vbNewLine + "Wait and signal INSIDE synchronization domain:" + vbNewLine)
        runWaiter = New Thread(AddressOf RunWaitKeepContext)
        runWaiter.Start(syncClass)
        Thread.Sleep(1000)
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode())
        ' This call to Signal will block until the timeout in DoWait expires.
        syncClass.Signal()
        runWaiter.Join()

        Console.WriteLine(vbNewLine + "Wait and signal OUTSIDE synchronization domain:" + vbNewLine)
        runWaiter = New Thread(AddressOf RunWaitLeaveContext)
        runWaiter.Start(syncClass)
        Thread.Sleep(1000)
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode())
        ' This call to Signal is unblocked and will set the wait handle to
        ' release the waiting thread.
        syncClass.Signal()
        runWaiter.Join()
    End Sub

    Public Shared Sub RunWaitKeepContext(parm As Object)
        Dim syncClass As SyncingClass = CType(parm, SyncingClass)
        syncClass.DoWait(False)
    End Sub

    Public Shared Sub RunWaitLeaveContext(parm As Object)
        Dim syncClass As SyncingClass = CType(parm, SyncingClass)
        syncClass.DoWait(True)
    End Sub
End Class

' The output for the example program will be similar to the following:
'
' Wait and signal INSIDE synchronization domain:
'
' Thread[0004]: Waiting...
' Thread[0001]: Signal...
' Thread[0004]: Wait timeout!!!
' Thread[0001]: Signalling...
'
' Wait and signal OUTSIDE synchronization domain:
'
' Thread[0006]: Waiting...
' Thread[0001]: Signal...
' Thread[0001]: Signalling...
' Thread[0006]: Wait released!!!

注釈

@No__t-0 が0の場合、メソッドはブロックしません。If millisecondsTimeout is zero, the method does not block. 待機ハンドルの状態をテストし、すぐに制御を戻します。It tests the state of the wait handle and returns immediately.

AbandonedMutexException は .NET Framework バージョン2.0 で新しく追加されたものです。AbandonedMutexException is new in the .NET Framework version 2.0. 以前のバージョンでは、ミューテックスが破棄されると、WaitOne メソッドは true を返します。In previous versions, the WaitOne method returns true when a mutex is abandoned. 多くの場合、放棄ミューテックスは深刻なコーディングエラーを示しています。An abandoned mutex often indicates a serious coding error. システム全体のミューテックスの場合は、アプリケーションが突然 (たとえば、Windows タスクマネージャーを使用して) 終了したことを示している可能性があります。In the case of a system-wide mutex, it might indicate that an application has been terminated abruptly (for example, by using Windows Task Manager). 例外には、デバッグに役立つ情報が含まれています。The exception contains information useful for debugging.

このメソッドの呼び出し元は、現在のインスタンスがシグナルを受信するか、タイムアウトが発生するまでブロックします。The caller of this method blocks until the current instance receives a signal or a time-out occurs. このメソッドは、非同期操作の完了時にが生成されるなど、WaitHandle が別のスレッドからのシグナルを受信するまでブロックするために使用します。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 詳細については、IAsyncResult インターフェイスのトピックを参照してください。For more information, see the IAsyncResult interface.

派生クラスの動作をカスタマイズするには、このメソッドをオーバーライドします。Override this method to customize the behavior of derived classes.

コンテキストの終了に関する注意事項Notes on Exiting the Context

@No__t-0 パラメーターは、WaitOne メソッドが既定以外のマネージコンテキストの内部から呼び出されない限り、効果はありません。The exitContext parameter has no effect unless the WaitOne method is called from inside a nondefault managed context. これは、スレッドが @no__t から派生したクラスのインスタンスの呼び出し内にある場合に発生することがあります。This can happen if your thread is inside a call to an instance of a class derived from ContextBoundObject. @No__t-0 から派生していないクラス (String など) でメソッドを現在実行している場合でも、現在のアプリケーションドメインのスタックに ContextBoundObject がある場合は、既定以外のコンテキストにすることができます。Even if you are currently executing a method on a class that does not derive from ContextBoundObject, like String, you can be in a nondefault context if a ContextBoundObject is on your stack in the current application domain.

コードが既定以外のコンテキストで実行されている場合、exitContexttrue を指定すると、スレッドは既定以外のマネージコンテキスト (つまり、既定のコンテキストに遷移する) を終了してから、WaitOne メソッドを実行します。When your code is executing in a nondefault context, specifying true for exitContext causes the thread to exit the nondefault managed context (that is, to transition to the default context) before executing the WaitOne method. @No__t-0 メソッドの呼び出しが完了すると、スレッドは元の既定以外のコンテキストに戻ります。The thread returns to the original nondefault context after the call to the WaitOne method completes.

これは、コンテキストバインドクラスの @no__t が0の場合に便利です。This can be useful when the context-bound class has SynchronizationAttribute. その場合、クラスのメンバーへのすべての呼び出しが自動的に同期され、同期ドメインがクラスのコード本文全体になります。In that case, all calls to members of the class are automatically synchronized, and the synchronization domain is the entire body of code for the class. メンバーの呼び出し履歴内のコードが WaitOne メソッドを呼び出し、exitContexttrue を指定した場合、スレッドは同期ドメインを終了します。これにより、オブジェクトの任意のメンバーへの呼び出しでブロックされているスレッドが処理を続行できるようになります。If code in the call stack of a member calls the WaitOne method and specifies true for exitContext, the thread exits the synchronization domain, allowing a thread that is blocked on a call to any member of the object to proceed. @No__t 0 のメソッドがを返した場合、呼び出しを行ったスレッドは、同期ドメインの再入力を待機する必要があります。When the WaitOne method returns, the thread that made the call must wait to reenter the synchronization domain.

WaitOne(TimeSpan, Boolean)

現在のインスタンスがシグナルを受信するまで現在のスレッドをブロックします。TimeSpan を使用して時間間隔を指定し、待機の前でも同期ドメインを終了するかどうかを指定します。Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval and specifying whether to exit the synchronization domain before the wait.

public:
 virtual bool WaitOne(TimeSpan timeout, bool exitContext);
public virtual bool WaitOne (TimeSpan timeout, bool exitContext);
abstract member WaitOne : TimeSpan * bool -> bool
override this.WaitOne : TimeSpan * bool -> bool
Public Overridable Function WaitOne (timeout As TimeSpan, exitContext As Boolean) As Boolean

パラメーター

timeout
TimeSpan

待機するミリ秒数を表す TimeSpan。無制限に待機する場合は、-1 ミリ秒を表す TimeSpanA TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

exitContext
Boolean

待機する前にコンテキストの同期ドメインを終了し (同期されたコンテキスト内にいる場合)、後で再取得する場合は、true。それ以外の場合は falsetrue to exit the synchronization domain for the context before the wait (if in a synchronized context), and reacquire it afterward; otherwise, false.

戻り値

現在のインスタンスがシグナルを受け取る場合は true。それ以外の場合は falsetrue if the current instance receives a signal; otherwise, false.

例外

現在のインスタンスは既に破棄されています。The current instance has already been disposed.

timeout は無限のタイムアウトを表す -1 ミリ秒以外の負の数です。timeout is a negative number other than -1 milliseconds, which represents an infinite time-out. または-or- timeoutMaxValue より大きくなっています。timeout is greater than MaxValue.

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。The wait completed because a thread exited without releasing a mutex. Windows 98 または Windows Millennium Edition では、この例外はスローされません。This exception is not thrown on Windows 98 or Windows Millennium Edition.

別のアプリケーション ドメインでは、現在のインスタンスは WaitHandle の透過プロキシです。The current instance is a transparent proxy for a WaitHandle in another application domain.

次のコード例は、待機ハンドルを使用して、バックグラウンドスレッドの実行が完了するのを待機している間にプロセスを終了しないようにする方法を示しています。The following code example shows how to use a wait handle to keep a process from terminating while it waits for a background thread to finish executing.

using namespace System;
using namespace System::Threading;
ref class WaitOne
{
private:
   WaitOne(){}


public:
   static void WorkMethod( Object^ stateInfo )
   {
      Console::WriteLine( "Work starting." );
      
      // Simulate time spent working.
      Thread::Sleep( (gcnew Random)->Next( 100, 2000 ) );
      
      // Signal that work is finished.
      Console::WriteLine( "Work ending." );
      dynamic_cast<AutoResetEvent^>(stateInfo)->Set();
   }

};

int main()
{
   Console::WriteLine( "Main starting." );
   AutoResetEvent^ autoEvent = gcnew AutoResetEvent( false );
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( &WaitOne::WorkMethod ), autoEvent );
   
   // Wait for work method to signal.
   if ( autoEvent->WaitOne( TimeSpan(0,0,1), false ) )
   {
      Console::WriteLine( "Work method signaled." );
   }
   else
   {
      Console::WriteLine( "Timed out waiting for work "
      "method to signal." );
   }

   Console::WriteLine( "Main ending." );
}

using System;
using System.Threading;

class WaitOne
{
    static AutoResetEvent autoEvent = new AutoResetEvent(false);

    static void Main()
    {
        Console.WriteLine("Main starting.");

        ThreadPool.QueueUserWorkItem(
            new WaitCallback(WorkMethod), autoEvent);

        // Wait for work method to signal.
        if(autoEvent.WaitOne(new TimeSpan(0, 0, 1), false))
        {
            Console.WriteLine("Work method signaled.");
        }
        else
        {
            Console.WriteLine("Timed out waiting for work " +
                "method to signal.");
        }
        Console.WriteLine("Main ending.");
    }

    static void WorkMethod(object stateInfo) 
    {
        Console.WriteLine("Work starting.");

        // Simulate time spent working.
        Thread.Sleep(new Random().Next(100, 2000));

        // Signal that work is finished.
        Console.WriteLine("Work ending.");
        ((AutoResetEvent)stateInfo).Set();
    }
}
Imports System.Threading

Public Class WaitOne

    Shared autoEvent As New AutoResetEvent(False)

    <MTAThread> _
    Shared Sub Main()
        Console.WriteLine("Main starting.")

        ThreadPool.QueueUserWorkItem(AddressOf WorkMethod, autoEvent)

        ' Wait for work method to signal.
        If autoEvent.WaitOne(New TimeSpan(0, 0, 1), False) Then
            Console.WriteLine("Work method signaled.")
        Else
            Console.WriteLine("Timed out waiting for work " & _
                "method to signal.")
        End If

        Console.WriteLine("Main ending.")
    End Sub

    Shared Sub WorkMethod(stateInfo As Object) 
        Console.WriteLine("Work starting.")

        ' Simulate time spent working.
        Thread.Sleep(New Random().Next(100, 2000))

        ' Signal that work is finished.
        Console.WriteLine("Work ending.")
        CType(stateInfo, AutoResetEvent).Set()
    End Sub

End Class

注釈

@No__t-0 が0の場合、メソッドはブロックしません。If timeout is zero, the method does not block. 待機ハンドルの状態をテストし、すぐに制御を戻します。It tests the state of the wait handle and returns immediately.

AbandonedMutexException は .NET Framework バージョン2.0 で新しく追加されたものです。AbandonedMutexException is new in the .NET Framework version 2.0. 以前のバージョンでは、ミューテックスが破棄されると、WaitOne メソッドは true を返します。In previous versions, the WaitOne method returns true when a mutex is abandoned. 多くの場合、放棄ミューテックスは深刻なコーディングエラーを示しています。An abandoned mutex often indicates a serious coding error. システム全体のミューテックスの場合は、アプリケーションが突然 (たとえば、Windows タスクマネージャーを使用して) 終了したことを示している可能性があります。In the case of a system-wide mutex, it might indicate that an application has been terminated abruptly (for example, by using Windows Task Manager). 例外には、デバッグに役立つ情報が含まれています。The exception contains information useful for debugging.

このメソッドの呼び出し元は、現在のインスタンスがシグナルを受信するか、タイムアウトが発生するまでブロックします。The caller of this method blocks until the current instance receives a signal or a time-out occurs. このメソッドは、非同期操作の完了時にが生成されるなど、WaitHandle が別のスレッドからのシグナルを受信するまでブロックするために使用します。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 詳細については、IAsyncResult インターフェイスのトピックを参照してください。For more information, see the IAsyncResult interface.

派生クラスの動作をカスタマイズするには、このメソッドをオーバーライドします。Override this method to customize the behavior of derived classes.

@No__t-0 の最大値は Int32.MaxValue です。The maximum value for timeout is Int32.MaxValue.

コンテキストの終了に関する注意事項Notes on Exiting the Context

@No__t-0 パラメーターは、WaitOne メソッドが既定以外のマネージコンテキストの内部から呼び出されない限り、効果はありません。The exitContext parameter has no effect unless the WaitOne method is called from inside a nondefault managed context. これは、スレッドが @no__t から派生したクラスのインスタンスの呼び出し内にある場合に発生することがあります。This can happen if your thread is inside a call to an instance of a class derived from ContextBoundObject. @No__t-0 から派生していないクラス (String など) でメソッドを現在実行している場合でも、現在のアプリケーションドメインのスタックに ContextBoundObject がある場合は、既定以外のコンテキストにすることができます。Even if you are currently executing a method on a class that does not derive from ContextBoundObject, like String, you can be in a nondefault context if a ContextBoundObject is on your stack in the current application domain.

コードが既定以外のコンテキストで実行されている場合、exitContexttrue を指定すると、スレッドは既定以外のマネージコンテキスト (つまり、既定のコンテキストに遷移する) を終了してから、WaitOne メソッドを実行します。When your code is executing in a nondefault context, specifying true for exitContext causes the thread to exit the nondefault managed context (that is, to transition to the default context) before executing the WaitOne method. @No__t-0 メソッドの呼び出しが完了すると、スレッドは元の既定以外のコンテキストに戻ります。The thread returns to the original nondefault context after the call to the WaitOne method completes.

これは、コンテキストバインドクラスの @no__t が0の場合に便利です。This can be useful when the context-bound class has SynchronizationAttribute. その場合、クラスのメンバーへのすべての呼び出しが自動的に同期され、同期ドメインがクラスのコード本文全体になります。In that case, all calls to members of the class are automatically synchronized, and the synchronization domain is the entire body of code for the class. メンバーの呼び出し履歴内のコードが WaitOne メソッドを呼び出し、exitContexttrue を指定した場合、スレッドは同期ドメインを終了します。これにより、オブジェクトの任意のメンバーへの呼び出しでブロックされているスレッドが処理を続行できるようになります。If code in the call stack of a member calls the WaitOne method and specifies true for exitContext, the thread exits the synchronization domain, allowing a thread that is blocked on a call to any member of the object to proceed. @No__t 0 のメソッドがを返した場合、呼び出しを行ったスレッドは、同期ドメインの再入力を待機する必要があります。When the WaitOne method returns, the thread that made the call must wait to reenter the synchronization domain.

適用対象