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)	初期状態をシグナル状態に設定するかどうかを示す 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()	イベントの状態をシグナル状態に設定して、イベント上で待機している 1 つ以上のスレッドが進行できるようにします。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
Wait()	現在の ManualResetEventSlim が設定されるまで、現在のスレッドをブロックします。
Wait(CancellationToken)	ManualResetEventSlim を観察すると同時に、現在の CancellationToken が信号を受信するまで、現在のスレッドをブロックします。
Wait(Int32)	32 ビット符号付き整数を使用して時間間隔を計測し、現在の ManualResetEventSlim が設定されるまで、現在のスレッドをブロックします。
Wait(Int32, CancellationToken)	ManualResetEventSlim を観察すると同時に、32 ビット符号付き整数を使用して時間間隔を計測し、現在の CancellationToken が設定されるまで、現在のスレッドをブロックします。
Wait(TimeSpan)	ManualResetEventSlim を使用して時間間隔を計測し、現在の TimeSpan が設定されるまで、現在のスレッドをブロックします。
Wait(TimeSpan, CancellationToken)	ManualResetEventSlim を観察すると同時に、TimeSpan を使用して時間間隔を計測し、現在の CancellationToken が設定されるまで、現在のスレッドをブロックします。

適用対象

スレッドセーフ

パブリックメンバーとプロテクトメンバー ManualResetEventSlim はすべてスレッドセーフであり、複数のスレッドから同時に使用できます。ただし、Dispose は、他のすべての操作が完了した場合にのみ使用する必要があります。Reset は、他のスレッドがイベントに ManualResetEventSlim アクセスしていない場合にのみ使用する必要があります。

こちらもご覧ください

同期プリミティブの概要