CountdownEvent Class

.NET Framework (current version)
 

Represents a synchronization primitive that is signaled when its count reaches zero.

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

System.Object
  System.Threading.CountdownEvent

[<ComVisibleAttribute(false)>]
[<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true,
    ExternalThreading = true)>]
type CountdownEvent = 
    class
        interface IDisposable
    end

NameDescription
System_CAPS_pubmethodCountdownEvent(Int32)

Initializes a new instance of CountdownEvent class with the specified count.

NameDescription
System_CAPS_pubpropertyCurrentCount

Gets the number of remaining signals required to set the event.

System_CAPS_pubpropertyInitialCount

Gets the numbers of signals initially required to set the event.

System_CAPS_pubpropertyIsSet

Indicates whether the CountdownEvent object's current count has reached zero..

System_CAPS_pubpropertyWaitHandle

Gets a WaitHandle that is used to wait for the event to be set.

NameDescription
System_CAPS_pubmethodAddCount()

Increments the CountdownEvent's current count by one.

System_CAPS_pubmethodAddCount(Int32)

Increments the CountdownEvent's current count by a specified value.

System_CAPS_pubmethodDispose()

Releases all resources used by the current instance of the CountdownEvent class.

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the CountdownEvent, and optionally releases the managed resources.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodReset()

Resets the CurrentCount to the value of InitialCount.

System_CAPS_pubmethodReset(Int32)

Resets the InitialCount property to a specified value.

System_CAPS_pubmethodSignal()

Registers a signal with the CountdownEvent, decrementing the value of CurrentCount.

System_CAPS_pubmethodSignal(Int32)

Registers multiple signals with the CountdownEvent, decrementing the value of CurrentCount by the specified amount.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodTryAddCount()

Attempts to increment CurrentCount by one.

System_CAPS_pubmethodTryAddCount(Int32)

Attempts to increment CurrentCount by a specified value.

System_CAPS_pubmethodWait()

Blocks the current thread until the CountdownEvent is set.

System_CAPS_pubmethodWait(CancellationToken)

Blocks the current thread until the CountdownEvent is set, while observing a CancellationToken.

System_CAPS_pubmethodWait(Int32)

Blocks the current thread until the CountdownEvent is set, using a 32-bit signed integer to measure the timeout.

System_CAPS_pubmethodWait(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.

System_CAPS_pubmethodWait(TimeSpan)

Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout.

System_CAPS_pubmethodWait(TimeSpan, CancellationToken)

Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout, while observing a CancellationToken.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1

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:

No code example is currently available or this language may not be supported.
Return to top
Show: