ManualResetEventSlim Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Provides a slimmed down version of ManualResetEvent.

Inheritance Hierarchy

System..::.Object
System.Threading..::.ManualResetEventSlim

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

Syntax

Public Class ManualResetEventSlim _
    Implements IDisposable
public class ManualResetEventSlim : IDisposable

The ManualResetEventSlim type exposes the following members.

Constructors

Name Description
ManualResetEventSlim()()() Initializes a new instance of the ManualResetEventSlim class with an initial state of nonsignaled.
ManualResetEventSlim(Boolean) Initializes a new instance of the ManualResetEventSlim class with a Boolean value indicating whether to set the intial state to signaled.
ManualResetEventSlim(Boolean, Int32) Initializes a new instance of the ManualResetEventSlim class with a Boolean value indicating whether to set the intial state to signaled and a specified spin count.

Top

Properties

Name Description
IsSet Gets whether the event is set.
SpinCount Gets the number of spin waits that will be occur before falling back to a kernel-based wait operation.
WaitHandle Gets the underlying WaitHandle object for this ManualResetEventSlim.

Top

Methods

Name Description
Dispose()()() Releases all resources used by the current instance of the ManualResetEventSlim class.
Dispose(Boolean) Releases the unmanaged resources used by the ManualResetEventSlim, 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 Sets the state of the event to nonsignaled, which causes threads to block.
Set Sets the state of the event to signaled, which allows one or more threads waiting on the event to proceed.
ToString Returns a string that represents the current object. (Inherited from Object.)
Wait()()() Blocks the current thread until the current ManualResetEventSlim is set.
Wait(CancellationToken) Blocks the current thread until the current ManualResetEventSlim receives a signal, while observing a CancellationToken.
Wait(Int32) Blocks the current thread until the current ManualResetEventSlim is set, using a 32-bit signed integer to measure the time interval.
Wait(TimeSpan) Blocks the current thread until the current ManualResetEventSlim is set, using a TimeSpan to measure the time interval.
Wait(Int32, CancellationToken) Blocks the current thread until the current ManualResetEventSlim is set, using a 32-bit signed integer to measure the time interval, while observing a CancellationToken.
Wait(TimeSpan, CancellationToken) Blocks the current thread until the current ManualResetEventSlim is set, using a TimeSpan to measure the time interval, while observing a CancellationToken.

Top

Examples

The following example shows how to use a ManualResetEventSlim. For more information about the use of SpinCount and other best practices concerning the use of this type, see [465fdcf9-ba24-4d8d-a43f-d983b7cb0cc6].

Version Information

Windows Phone OS

Supported in: 8.1, 8.0

Thread Safety

All public and protected members of ManualResetEventSlim 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 ManualResetEventSlim have completed, and Reset, which should only be used when no other threads are accessing the event.

See Also

Reference

System.Threading Namespace