Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

ManualResetEventSlim Class

.NET Framework 4.6 and 4.5

Provides a slimmed down version of ManualResetEvent.

System.Object
  System.Threading.ManualResetEventSlim

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

[<ComVisibleAttribute(false)>]
[<DebuggerDisplayAttribute("Set = {IsSet}")>]
[<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true, 
    ExternalThreading = true)>]
type ManualResetEventSlim =  
    class 
        interface IDisposable 
    end

The ManualResetEventSlim type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibraryManualResetEventSlim()Initializes a new instance of the ManualResetEventSlim class with an initial state of nonsignaled.
Public methodSupported by Portable Class LibraryManualResetEventSlim(Boolean)Initializes a new instance of the ManualResetEventSlim class with a Boolean value indicating whether to set the intial state to signaled.
Public methodSupported by Portable Class LibraryManualResetEventSlim(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

  NameDescription
Public propertySupported by Portable Class LibraryIsSetGets whether the event is set.
Public propertySupported by Portable Class LibrarySpinCountGets the number of spin waits that will be occur before falling back to a kernel-based wait operation.
Public propertySupported by Portable Class LibraryWaitHandleGets the underlying WaitHandle object for this ManualResetEventSlim.
Top

  NameDescription
Public methodSupported by Portable Class LibraryDispose()Releases all resources used by the current instance of the ManualResetEventSlim class.
Protected methodSupported by Portable Class LibraryDispose(Boolean)Releases the unmanaged resources used by the ManualResetEventSlim, and optionally releases the managed resources.
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryResetSets the state of the event to nonsignaled, which causes threads to block.
Public methodSupported by Portable Class LibrarySetSets the state of the event to signaled, which allows one or more threads waiting on the event to proceed.
Public methodSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryWait()Blocks the current thread until the current ManualResetEventSlim is set.
Public methodSupported by Portable Class LibraryWait(CancellationToken)Blocks the current thread until the current ManualResetEventSlim receives a signal, while observing a CancellationToken.
Public methodSupported by Portable Class LibraryWait(Int32)Blocks the current thread until the current ManualResetEventSlim is set, using a 32-bit signed integer to measure the time interval.
Public methodSupported by Portable Class LibraryWait(TimeSpan)Blocks the current thread until the current ManualResetEventSlim is set, using a TimeSpan to measure the time interval.
Public methodSupported by Portable Class LibraryWait(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.
Public methodSupported by Portable Class LibraryWait(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

You can use this class for better performance than ManualResetEvent when wait times are expected to be very short, and when the event does not cross a process boundary. ManualResetEventSlim uses busy spinning for a short time while it waits for the event to become signaled. When wait times are short, spinning can be much less expensive than waiting by using wait handles. However, if the event does not become signaled within a certain period of time, ManualResetEventSlim resorts to a regular event handle wait.

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 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 ManualResetEvent and ManualResetEventSlim.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

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.

Show:
© 2015 Microsoft