CountdownEvent Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Represents a synchronization primitive that is signaled when its count reaches zero.
Assembly: mscorlib (in mscorlib.dll)
The CountdownEvent type exposes the following members.
| Name | Description | |
|---|---|---|
 | CountdownEvent | Initializes a new instance of CountdownEvent class with the specified count. |
| Name | Description | |
|---|---|---|
 | CurrentCount | Gets the number of remaining signals required to set the event. |
| InitialCount | Gets the numbers of signals initially required to set the event. |
| IsSet | Determines whether the event is set. |
| WaitHandle | Gets a WaitHandle that is used to wait for the event to be set. |
| Name | Description | |
|---|---|---|
| AddCount() | Increments the CountdownEvent's current count by one. |
| AddCount(Int32) | Increments the CountdownEvent's current count by a specified value. |
| Dispose() | Releases all resources used by the current instance of the CountdownEvent class. |
 | Dispose(Boolean) | Releases the unmanaged resources used by the CountdownEvent, and optionally releases the managed resources. |
| Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Reset() | Resets the CurrentCount to the value of InitialCount. |
| Reset(Int32) | Resets the InitialCount property to a specified value. |
| Signal() | Registers a signal with the CountdownEvent, decrementing the value of CurrentCount. |
| Signal(Int32) | Registers multiple signals with the CountdownEvent, decrementing the value of CurrentCount by the specified amount. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryAddCount() | Attempts to increment CurrentCount by one. |
| TryAddCount(Int32) | Attempts to increment CurrentCount by a specified value. |
| Wait() | Blocks the current thread until the CountdownEvent is set. |
| Wait(CancellationToken) | Blocks the current thread until the CountdownEvent is set, while observing a CancellationToken. |
| Wait(Int32) | Blocks the current thread until the CountdownEvent is set, using a 32-bit signed integer to measure the timeout. |
| Wait(TimeSpan) | Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout. |
| Wait(Int32, CancellationToken) | Blocks the current thread until the CountdownEvent is set, using a 32-bit signed integer to measure the timeout, while observing a CancellationToken. |
| Wait(TimeSpan, CancellationToken) | Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout, while observing a CancellationToken. |
All public and protected members of CountdownEvent are thread-safe and may be used concurrently from multiple threads, with the exception of Dispose, which must only be used when all other operations on the CountdownEvent have completed, and Reset, which should only be used when no other threads are accessing the event.
Example
The following example shows how to use a CountdownEvent:
Show: