ManualResetEventSlim 类

参考

定义

命名空间:: System.Threading

程序集:: System.Threading.dll

程序集:: mscorlib.dll

程序集:: netstandard.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

表示线程同步事件，收到信号时，必须手动重置该事件。此类是 ManualResetEvent 的轻量替代项。

public ref class ManualResetEventSlim : IDisposable

public class ManualResetEventSlim : IDisposable

[System.Runtime.InteropServices.ComVisible(false)]
public class ManualResetEventSlim : IDisposable

type ManualResetEventSlim = class
    interface IDisposable

[<System.Runtime.InteropServices.ComVisible(false)>]
type ManualResetEventSlim = class
    interface IDisposable

Public Class ManualResetEventSlim
Implements IDisposable

继承: Object
ManualResetEventSlim

属性: ComVisibleAttribute

实现: IDisposable

示例

以下示例演示如何使用 ManualResetEventSlim.

using System;
using System.Threading;
using System.Threading.Tasks;
class MRESDemo
{

    static void Main()
    {
        MRES_SetWaitReset();
        MRES_SpinCountWaitHandle();
    }
    // Demonstrates:
    //      ManualResetEventSlim construction
    //      ManualResetEventSlim.Wait()
    //      ManualResetEventSlim.Set()
    //      ManualResetEventSlim.Reset()
    //      ManualResetEventSlim.IsSet
    static void MRES_SetWaitReset()
    {
        ManualResetEventSlim mres1 = new ManualResetEventSlim(false); // initialize as unsignaled
        ManualResetEventSlim mres2 = new ManualResetEventSlim(false); // initialize as unsignaled
        ManualResetEventSlim mres3 = new ManualResetEventSlim(true);  // initialize as signaled

        // Start an asynchronous Task that manipulates mres3 and mres2
        var observer = Task.Factory.StartNew(() =>
        {
            mres1.Wait();
            Console.WriteLine("observer sees signaled mres1!");
            Console.WriteLine("observer resetting mres3...");
            mres3.Reset(); // should switch to unsignaled
            Console.WriteLine("observer signalling mres2");
            mres2.Set();
        });

        Console.WriteLine("main thread: mres3.IsSet = {0} (should be true)", mres3.IsSet);
        Console.WriteLine("main thread signalling mres1");
        mres1.Set(); // This will "kick off" the observer Task
        mres2.Wait(); // This won't return until observer Task has finished resetting mres3
        Console.WriteLine("main thread sees signaled mres2!");
        Console.WriteLine("main thread: mres3.IsSet = {0} (should be false)", mres3.IsSet);

        // It's good form to Dispose() a ManualResetEventSlim when you're done with it
        observer.Wait(); // make sure that this has fully completed
        mres1.Dispose();
        mres2.Dispose();
        mres3.Dispose();
    }

    // Demonstrates:
    //      ManualResetEventSlim construction w/ SpinCount
    //      ManualResetEventSlim.WaitHandle
    static void MRES_SpinCountWaitHandle()
    {
        // Construct a ManualResetEventSlim with a SpinCount of 1000
        // Higher spincount => longer time the MRES will spin-wait before taking lock
        ManualResetEventSlim mres1 = new ManualResetEventSlim(false, 1000);
        ManualResetEventSlim mres2 = new ManualResetEventSlim(false, 1000);

        Task bgTask = Task.Factory.StartNew(() =>
        {
            // Just wait a little
            Thread.Sleep(100);

            // Now signal both MRESes
            Console.WriteLine("Task signalling both MRESes");
            mres1.Set();
            mres2.Set();
        });

        // A common use of MRES.WaitHandle is to use MRES as a participant in 
        // WaitHandle.WaitAll/WaitAny.  Note that accessing MRES.WaitHandle will
        // result in the unconditional inflation of the underlying ManualResetEvent.
        WaitHandle.WaitAll(new WaitHandle[] { mres1.WaitHandle, mres2.WaitHandle });
        Console.WriteLine("WaitHandle.WaitAll(mres1.WaitHandle, mres2.WaitHandle) completed.");

        // Clean up
        bgTask.Wait();
        mres1.Dispose();
        mres2.Dispose();
    }
}

Imports System.Threading
Imports System.Threading.Tasks

Module MRESDemo

    Sub Main()

    End Sub
    ' Demonstrates:
    ' ManualResetEventSlim construction
    ' ManualResetEventSlim.Wait()
    ' ManualResetEventSlim.Set()
    ' ManualResetEventSlim.Reset()
    ' ManualResetEventSlim.IsSet
    Private Sub MRES_SetWaitReset()
        ' initialize as unsignaled
        Dim mres1 As New ManualResetEventSlim(False)
        ' initialize as unsignaled
        Dim mres2 As New ManualResetEventSlim(False)
        ' initialize as signaled
        Dim mres3 As New ManualResetEventSlim(True)

        ' Start an asynchronous Task that manipulates mres3 and mres2
        Dim observer = Task.Factory.StartNew(
            Sub()
                mres1.Wait()
                Console.WriteLine("observer sees signaled mres1!")
                Console.WriteLine("observer resetting mres3...")
                mres3.Reset()
                ' should switch to unsignaled
                Console.WriteLine("observer signalling mres2")
                mres2.[Set]()
            End Sub)

        Console.WriteLine("main thread: mres3.IsSet = {0} (should be true)", mres3.IsSet)
        Console.WriteLine("main thread signalling mres1")
        mres1.[Set]()
        ' This will "kick off" the observer Task
        mres2.Wait()
        ' This won't return until observer Task has finished resetting mres3
        Console.WriteLine("main thread sees signaled mres2!")
        Console.WriteLine("main thread: mres3.IsSet = {0} (should be false)", mres3.IsSet)

        ' make sure that observer has fully completed
        observer.Wait()
        ' It's good form to Dispose() a ManualResetEventSlim when you're done with it
        mres1.Dispose()
        mres2.Dispose()
        mres3.Dispose()
    End Sub

    ' Demonstrates:
    ' ManualResetEventSlim construction w/ SpinCount
    ' ManualResetEventSlim.WaitHandle
    Private Sub MRES_SpinCountWaitHandle()
        ' Construct a ManualResetEventSlim with a SpinCount of 1000
        ' Higher spincount => longer time the MRES will spin-wait before taking lock
        Dim mres1 As New ManualResetEventSlim(False, 1000)
        Dim mres2 As New ManualResetEventSlim(False, 1000)

        Dim bgTask As Task = Task.Factory.StartNew(
            Sub()
                ' Just wait a little
                Thread.Sleep(100)

                ' Now signal both MRESes
                Console.WriteLine("Task signalling both MRESes")
                mres1.[Set]()
                mres2.[Set]()
            End Sub)

        ' A common use of MRES.WaitHandle is to use MRES as a participant in 
        ' WaitHandle.WaitAll/WaitAny. Note that accessing MRES.WaitHandle will
        ' result in the unconditional inflation of the underlying ManualResetEvent.
        WaitHandle.WaitAll(New WaitHandle() {mres1.WaitHandle, mres2.WaitHandle})
        Console.WriteLine("WaitHandle.WaitAll(mres1.WaitHandle, mres2.WaitHandle) completed.")

        ' Wait for bgTask to complete and clean up
        bgTask.Wait()
        mres1.Dispose()
        mres2.Dispose()
    End Sub
End Module

注解

可以将此类用于性能优于 ManualResetEvent 预期等待时间非常短的时间，并且当事件未跨越进程边界时。等待事件收到信号期间，ManualResetEventSlim 会短暂使用忙碌旋转。等待时间较短时，旋转的开销相对于使用等待句柄来进行等待的开销会少很多。不过，如果在特定时间段内事件没有收到信号，ManualResetEventSlim 会求助于常规的事件句柄等待。

备注

在 .NET Core 和 .NET 5+中，默认旋转等待持续时间较短：根据平台和处理器的 10 秒微秒的顺序。如果预计等待时间要长于这一点，你仍然可以使用此类，而不是 ManualResetEvent (可能配置为更少或没有旋转等待) 。但是，性能优势可能只是微不足道的。

构造函数

ManualResetEventSlim()	使用无信号初始状态初始化 ManualResetEventSlim 类的新实例。
ManualResetEventSlim(Boolean)	用一个指示是否将初始状态设置为终止的布尔值初始化 ManualResetEventSlim 类的新实例。
ManualResetEventSlim(Boolean, Int32)	使用一个指示是否将初始状态设置为有信号和指定自旋计数的布尔值初始化 ManualResetEventSlim 类的新实例。

属性

IsSet	获取是否已设置事件。
SpinCount	获取在回退到基于内核的等待操作之前将发生的自旋等待数量。
WaitHandle	获取此 WaitHandle 的基础 ManualResetEventSlim 对象。

方法

Dispose()	释放 ManualResetEventSlim 类的当前实例所使用的所有资源。
Dispose(Boolean)	释放由 ManualResetEventSlim 占用的非托管资源，还可以另外再释放托管资源。
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetType()	获取当前实例的 Type。 (继承自 Object)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
Reset()	将事件状态设置为非终止，从而导致线程受阻。
Set()	将事件状态设置为有信号，从而允许一个或多个等待该事件的线程继续。
ToString()	返回表示当前对象的字符串。 (继承自 Object)
Wait()	阻止当前线程，直到设置了当前 ManualResetEventSlim 为止。
Wait(CancellationToken)	阻止当前线程，直到当前 ManualResetEventSlim 收到信号为止，同时观察 CancellationToken。
Wait(Int32)	阻止当前线程，直到设置了当前 ManualResetEventSlim 为止，同时使用 32 位带符号整数测量时间间隔。
Wait(Int32, CancellationToken)	阻止当前线程，直到设置了当前 ManualResetEventSlim 为止，并使用 32 位带符号整数测量时间间隔，同时观察 CancellationToken。
Wait(TimeSpan)	阻止当前线程，直到设置了当前 ManualResetEventSlim 为止，同时使用 TimeSpan 测量时间间隔。
Wait(TimeSpan, CancellationToken)	阻止当前线程，直到设置了当前 ManualResetEventSlim 为止，并使用 TimeSpan 测量时间间隔，同时观察 CancellationToken。

适用于

线程安全性

所有公共成员和受保护的成员 ManualResetEventSlim 都是线程安全的，并且可能同时从多个线程使用，但 Dispose 除外，这只能在已完成所有其他操作 ManualResetEventSlim 时使用，而重置仅在没有其他线程访问事件时才使用。

另请参阅

同步基元概述

ManualResetEventSlim 类

定义

示例

注解

构造函数

属性

方法

适用于

线程安全性

另请参阅

其他资源