Export (0) Print
Expand All

EventWaitHandle Class

Updated: April 2011

Represents a thread synchronization event.

Namespace:  System.Threading
Assembly:  mscorlib (in mscorlib.dll)

[ComVisibleAttribute(true)]
[HostProtectionAttribute(SecurityAction::LinkDemand, Synchronization = true, 
	ExternalThreading = true)]
public ref class EventWaitHandle : public WaitHandle

NoteNote:

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization | ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The EventWaitHandle class allows threads to communicate with each other by signaling. Typically, one or more threads block on an EventWaitHandle until an unblocked thread calls the Set method, releasing one or more of the blocked threads. A thread can signal an EventWaitHandle and then block on it, by calling the static (Shared in Visual Basic) WaitHandle::SignalAndWait method.

NoteNote:

The EventWaitHandle class provides access to named system synchronization events.

The behavior of an EventWaitHandle that has been signaled depends on its reset mode. An EventWaitHandle created with the EventResetMode::AutoReset flag resets automatically when signaled, after releasing a single waiting thread. An EventWaitHandle created with the EventResetMode::ManualReset flag remains signaled until its Reset method is called.

Automatic reset events provide exclusive access to a resource. If an automatic reset event is signaled when no threads are waiting, it remains signaled until a thread attempts to wait on it. The event releases the thread and immediately resets, blocking subsequent threads.

Manual reset events are like gates. When the event is not signaled, threads that wait on it will block. When the event is signaled, all waiting threads are released, and the event remains signaled (that is, subsequent waits do not block) until its Reset method is called. Manual reset events are useful when one thread must complete an activity before other threads can proceed.

EventWaitHandle objects can be used with the static (Shared in Visual Basic) WaitHandle::WaitAll and WaitHandle::WaitAny methods.

For more information about thread synchronization mechanisms, see EventWaitHandle, AutoResetEvent, and ManualResetEvent.

The following code example uses the SignalAndWait(WaitHandle, WaitHandle) method overload to allow the main thread to signal a blocked thread and then wait until the thread finishes a task.

The example starts five threads and allows them to block on an EventWaitHandle created with the EventResetMode::AutoReset flag, then releases one thread each time the user presses the ENTER key. The example then queues another five threads and releases them all using an EventWaitHandle created with the EventResetMode::ManualReset flag.

using namespace System;
using namespace System::Threading;

public ref class Example
{
private:
   // The EventWaitHandle used to demonstrate the difference 
   // between AutoReset and ManualReset synchronization events. 
   // 
   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. 
   // 
   static __int64 threadCount = 0;

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

public:
   [MTAThread]
   static void main()
   {
      // Create an AutoReset EventWaitHandle. 
      //
      ewh = gcnew 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 = gcnew Thread(
            gcnew 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( threadCount ) < 5 )
      {
         Thread::Sleep( 500 );
      }

      // Release one thread each time the user presses ENTER, 
      // until all threads have been released. 
      // 
      while ( Interlocked::Read( threadCount ) > 0 )
      {
         Console::WriteLine( L"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 = gcnew EventWaitHandle( false,EventResetMode::ManualReset );

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

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

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

   }

   static void ThreadProc( Object^ data )
   {
      int index = static_cast<Int32>(data);

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

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

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

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

This type is thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5

XNA Framework

Supported in: 3.0, 2.0, 1.0

Date

History

Reason

April 2011

Correction: The WaitHandle::SignalAndWait method is not atomic.

Customer feedback.

Community Additions

ADD
Show:
© 2014 Microsoft