ManualResetEventSlim Класс

Определение

Пространство имен:
System.Threading
Сборки:
mscorlib.dll, System.Threading.dll
Сборки:
netstandard.dll, System.Threading.dll
Сборка:
System.Threading.dll
Сборка:
mscorlib.dll
Сборка:
netstandard.dll
Исходный код:
ManualResetEventSlim.cs
Исходный код:
ManualResetEventSlim.cs
Исходный код:
ManualResetEventSlim.cs
Исходный код:
ManualResetEventSlim.cs
Исходный код:
ManualResetEventSlim.cs

Представляет событие синхронизации потоков, которое при сигнале должно быть сброшено вручную. Этот класс является упрощенной альтернативой 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 прибегает к регулярному дескриптору событий ожидания.

Note

В .NET Core и .NET 5+, длительность ожидания по умолчанию коротка: по 10-м микросекундам в зависимости от платформы и процессора. Если вы ожидаете, что время ожидания будет гораздо больше, чем это, вы по-прежнему можете использовать этот класс вместо ManualResetEvent (возможно, настроен меньше или без спин-ожиданий). Однако преимущество производительности, скорее всего, будет лишь незначительным.

Конструкторы

Имя Описание
ManualResetEventSlim()

Инициализирует новый экземпляр ManualResetEventSlim класса с начальным состоянием без знака.
ManualResetEventSlim(Boolean, Int32)

Инициализирует новый экземпляр ManualResetEventSlim класса с логическим значением, указывающим, следует ли задать начальное состояние для сигнала и указанное число спинов.
ManualResetEventSlim(Boolean)

Инициализирует новый экземпляр 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, CancellationToken)

Блокирует текущий поток до тех пор, пока текущий ManualResetEventSlim не задан, используя 32-разрядное целое число со знаком для измерения интервала времени при наблюдении CancellationTokenза .
Wait(Int32)

Блокирует текущий поток, пока текущий ManualResetEventSlim не задан, используя 32-разрядное целое число со знаком для измерения интервала времени.
Wait(TimeSpan, CancellationToken)

Блокирует текущий поток до тех пор, пока текущий ManualResetEventSlim не задан, используя TimeSpan для измерения интервала времени при наблюдении за ней CancellationToken.
Wait(TimeSpan)

Блокирует текущий поток до тех пор, пока текущий ManualResetEventSlim не задан, используя TimeSpan для измерения интервала времени.

Применяется к

Потокобезопасность

Все общедоступные и защищенные члены ManualResetEventSlim являются потокобезопасными и могут использоваться одновременно из нескольких потоков, за исключением Dispose, которые должны использоваться только при завершении всех других операций с ManualResetEventSlim завершением и сбросом, которые следует использовать только в том случае, если другие потоки не обращаются к событию.

См. также раздел