CountdownEvent CountdownEvent CountdownEvent CountdownEvent Class

定義

カウントが 0 になったときに通知される同期プリミティブを表します。Represents a synchronization primitive that is signaled when its count reaches zero.

public ref class CountdownEvent : IDisposable
[System.Runtime.InteropServices.ComVisible(false)]
public class CountdownEvent : IDisposable
type CountdownEvent = class
    interface IDisposable
Public Class CountdownEvent
Implements IDisposable
継承
CountdownEventCountdownEventCountdownEventCountdownEvent
属性
実装

次の例は、をCountdownEvent使用する方法を示しています。The following example shows how to use a CountdownEvent:

using System;
using System.Collections.Concurrent;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;

class Example
{
    static async Task Main()
    {
        // Initialize a queue and a CountdownEvent
        ConcurrentQueue<int> queue = new ConcurrentQueue<int>(Enumerable.Range(0, 10000));
        CountdownEvent cde = new CountdownEvent(10000); // initial count = 10000

        // This is the logic for all queue consumers
        Action consumer = () =>
        {
            int local;
            // decrement CDE count once for each element consumed from queue
            while (queue.TryDequeue(out local)) cde.Signal();
        };

        // Now empty the queue with a couple of asynchronous tasks
        Task t1 = Task.Factory.StartNew(consumer);
        Task t2 = Task.Factory.StartNew(consumer);

        // And wait for queue to empty by waiting on cde
        cde.Wait(); // will return when cde count reaches 0

        Console.WriteLine("Done emptying queue.  InitialCount={0}, CurrentCount={1}, IsSet={2}",
            cde.InitialCount, cde.CurrentCount, cde.IsSet);

        // Proper form is to wait for the tasks to complete, even if you that their work
        // is done already.
        await Task.WhenAll(t1, t2);

        // Resetting will cause the CountdownEvent to un-set, and resets InitialCount/CurrentCount
        // to the specified value
        cde.Reset(10);

        // AddCount will affect the CurrentCount, but not the InitialCount
        cde.AddCount(2);

        Console.WriteLine("After Reset(10), AddCount(2): InitialCount={0}, CurrentCount={1}, IsSet={2}",
            cde.InitialCount, cde.CurrentCount, cde.IsSet);

        // Now try waiting with cancellation
        CancellationTokenSource cts = new CancellationTokenSource();
        cts.Cancel(); // cancels the CancellationTokenSource
        try
        {
            cde.Wait(cts.Token);
        }
        catch (OperationCanceledException)
        {
            Console.WriteLine("cde.Wait(preCanceledToken) threw OCE, as expected");
        }
        finally
        {
           cts.Dispose();
        }
        // It's good to release a CountdownEvent when you're done with it.
        cde.Dispose();
    }
}
// The example displays the following output:
//    Done emptying queue.  InitialCount=10000, CurrentCount=0, IsSet=True
//    After Reset(10), AddCount(2): InitialCount=10, CurrentCount=12, IsSet=False
//    cde.Wait(preCanceledToken) threw OCE, as expected
Imports System.Collections.Concurrent
Imports System.Linq
Imports System.Threading
Imports System.Threading.Tasks

Module Example
    Sub Main()
        ' Initialize a queue and a CountdownEvent
        Dim queue As New ConcurrentQueue(Of Integer)(Enumerable.Range(0, 10000))
        Dim cde As New CountdownEvent(10000)
        ' initial count = 10000
        ' This is the logic for all queue consumers
        Dim consumer As Action =
            Sub()
                Dim local As Integer
                ' decrement CDE count once for each element consumed from queue
                While queue.TryDequeue(local)
                    cde.Signal()
                End While
            End Sub

        ' Now empty the queue with a couple of asynchronous tasks
        Dim t1 As Task = Task.Factory.StartNew(consumer)
        Dim t2 As Task = Task.Factory.StartNew(consumer)

        ' And wait for queue to empty by waiting on cde
        cde.Wait()
        ' will return when cde count reaches 0
        Console.WriteLine("Done emptying queue. InitialCount={0}, CurrentCount={1}, IsSet={2}", cde.InitialCount, cde.CurrentCount, cde.IsSet)

        ' Proper form is to wait for the tasks to complete, even if you know that their work
        ' is done already.
        Task.WaitAll(t1, t2)

        ' Resetting will cause the CountdownEvent to un-set, and resets InitialCount/CurrentCount
        ' to the specified value
        cde.Reset(10)

        ' AddCount will affect the CurrentCount, but not the InitialCount
        cde.AddCount(2)

        Console.WriteLine("After Reset(10), AddCount(2): InitialCount={0}, CurrentCount={1}, IsSet={2}", cde.InitialCount, cde.CurrentCount, cde.IsSet)

        ' Now try waiting with cancellation
        Dim cts As New CancellationTokenSource()
        cts.Cancel()
        ' cancels the CancellationTokenSource
        Try
            cde.Wait(cts.Token)
        Catch generatedExceptionName As OperationCanceledException
            Console.WriteLine("cde.Wait(preCanceledToken) threw OCE, as expected")
        Finally
           cts.Dispose()
        End Try

        ' It's good to release a CountdownEvent when you're done with it.
        cde.Dispose()
    End Sub
End Module
' The example displays the following output:
'    Done emptying queue.  InitialCount=10000, CurrentCount=0, IsSet=True
'    After Reset(10), AddCount(2): InitialCount=10, CurrentCount=12, IsSet=False
'    cde.Wait(preCanceledToken) threw OCE, as expected

コンストラクター

CountdownEvent(Int32) CountdownEvent(Int32) CountdownEvent(Int32) CountdownEvent(Int32)

指定されたカウントを使用して CountdownEvent クラスの新しいインスタンスを初期化します。Initializes a new instance of CountdownEvent class with the specified count.

プロパティ

CurrentCount CurrentCount CurrentCount CurrentCount

イベントの設定に必要な残りの通知の数を取得します。Gets the number of remaining signals required to set the event.

InitialCount InitialCount InitialCount InitialCount

イベントの設定に最初に必要な通知の数を取得します。Gets the numbers of signals initially required to set the event.

IsSet IsSet IsSet IsSet

CountdownEvent オブジェクトの現在の数が 0 に達したかどうかを示します。Indicates whether the CountdownEvent object's current count has reached zero.

WaitHandle WaitHandle WaitHandle WaitHandle

イベントの設定を待機するために使用する WaitHandle を取得します。Gets a WaitHandle that is used to wait for the event to be set.

メソッド

AddCount() AddCount() AddCount() AddCount()

CountdownEvent の現在のカウントを 1 つインクリメントします。Increments the CountdownEvent's current count by one.

AddCount(Int32) AddCount(Int32) AddCount(Int32) AddCount(Int32)

CountdownEvent の現在のカウントを指定された値だけインクリメントします。Increments the CountdownEvent's current count by a specified value.

Dispose() Dispose() Dispose() Dispose()

CountdownEvent クラスの現在のインスタンスによって使用されているすべてのリソースを解放します。Releases all resources used by the current instance of the CountdownEvent class.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

CountdownEvent が使用しているアンマネージド リソースを解放します。オプションとして、マネージド リソースを解放することもできます。Releases the unmanaged resources used by the CountdownEvent, and optionally releases the managed resources.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
Reset() Reset() Reset() Reset()

CurrentCountInitialCount の値にリセットします。Resets the CurrentCount to the value of InitialCount.

Reset(Int32) Reset(Int32) Reset(Int32) Reset(Int32)

InitialCount プロパティを指定した値にリセットします。Resets the InitialCount property to a specified value.

Signal() Signal() Signal() Signal()

通知を CountdownEvent に登録して、CurrentCount の値をデクリメントします。Registers a signal with the CountdownEvent, decrementing the value of CurrentCount.

Signal(Int32) Signal(Int32) Signal(Int32) Signal(Int32)

複数の通知を CountdownEvent に登録して、CurrentCount の値を指定された量だけデクリメントします。Registers multiple signals with the CountdownEvent, decrementing the value of CurrentCount by the specified amount.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)
TryAddCount() TryAddCount() TryAddCount() TryAddCount()

CurrentCount を 1 つインクリメントすることを試みます。Attempts to increment CurrentCount by one.

TryAddCount(Int32) TryAddCount(Int32) TryAddCount(Int32) TryAddCount(Int32)

CurrentCount を指定した値だけインクリメントすることを試みます。Attempts to increment CurrentCount by a specified value.

Wait() Wait() Wait() Wait()

CountdownEvent が設定されるまで、現在のスレッドをブロックします。Blocks the current thread until the CountdownEvent is set.

Wait(CancellationToken) Wait(CancellationToken) Wait(CancellationToken) Wait(CancellationToken)

CountdownEvent を観察すると同時に、CancellationToken が設定されるまで、現在のスレッドをブロックします。Blocks the current thread until the CountdownEvent is set, while observing a CancellationToken.

Wait(Int32) Wait(Int32) Wait(Int32) Wait(Int32)

32 ビット符号付き整数を使用してタイムアウトを計測し、CountdownEvent が設定されるまで、現在のスレッドをブロックします。Blocks the current thread until the CountdownEvent is set, using a 32-bit signed integer to measure the timeout.

Wait(Int32, CancellationToken) Wait(Int32, CancellationToken) Wait(Int32, CancellationToken) Wait(Int32, CancellationToken)

CountdownEvent を観察すると同時に、32 ビット符号付き整数を使用してタイムアウトを計測し、現在の CancellationToken が設定されるまで、現在のスレッドをブロックします。Blocks the current thread until the CountdownEvent is set, using a 32-bit signed integer to measure the timeout, while observing a CancellationToken.

Wait(TimeSpan) Wait(TimeSpan) Wait(TimeSpan) Wait(TimeSpan)

CountdownEvent を使用してタイムアウトを計測し、TimeSpan が設定されるまで、現在のスレッドをブロックします。Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout.

Wait(TimeSpan, CancellationToken) Wait(TimeSpan, CancellationToken) Wait(TimeSpan, CancellationToken) Wait(TimeSpan, CancellationToken)

CountdownEvent を観察すると同時に、TimeSpan を使用してタイムアウトを計測し、CancellationToken が設定されるまで、現在のスレッドをブロックします。Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout, while observing a CancellationToken.

適用対象

スレッド セーフ

CountdownEventパブリックメンバーとプロテクトメンバーはすべてスレッドセーフであり、複数のスレッドから同時に使用することがDispose()できます。ただし、の他のCountdownEventすべての操作が完了Reset()している場合にのみ使用する必要があります。。他のスレッドがイベントにアクセスしていない場合にのみ使用します。All public and protected members of CountdownEvent 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 CountdownEvent have completed, and Reset(), which should only be used when no other threads are accessing the event.

こちらもご覧ください