CountdownEvent Класс

Определение

Пространство имен:

System.Threading

Сборки:

netstandard.dll, System.Threading.dll

Исходный код:

CountdownEvent.cs

Представляет примитив синхронизации, который сигнализирует, когда его число достигает нуля.

public ref class CountdownEvent : IDisposable

public class CountdownEvent : IDisposable

type CountdownEvent = class
    interface IDisposable

Public Class CountdownEvent
Implements IDisposable

Наследование

Object

CountdownEvent

Реализации

IDisposable

Примеры

В следующем примере показано, как использовать :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 know 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 класса с указанным числом.

Свойства

Имя	Описание
CurrentCount	Возвращает количество оставшихся сигналов, необходимых для задания события.
InitialCount	Возвращает число сигналов, которые изначально необходимы для задания события.
IsSet	Указывает, достигло ли CountdownEvent текущее число объекта нулю.
WaitHandle	Возвращает значение WaitHandle , которое используется для ожидания установки события.

Методы

Имя	Описание
AddCount()	Увеличивает CountdownEventтекущее число по одному.
AddCount(Int32)	Увеличивает CountdownEventтекущее число по указанному значению.
Dispose()	Освобождает все ресурсы, используемые текущим экземпляром класса CountdownEvent.
Dispose(Boolean)	Освобождает неуправляемые ресурсы, используемые CountdownEventи при необходимости освобождает управляемые ресурсы.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
Reset()	Сбрасывает CurrentCount значение InitialCount.
Reset(Int32)	Сбрасывает InitialCount свойство в указанное значение.
Signal()	Регистрирует сигнал с CountdownEventпомощью параметра , уменьшающего значение CurrentCount.
Signal(Int32)	Регистрирует несколько сигналов с CountdownEventпомощью параметра , уменьшающего значение указанного CurrentCount значения.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
TryAddCount()	Пытается увеличить по CurrentCount одному.
TryAddCount(Int32)	Пытается увеличиться CurrentCount по указанному значению.
Wait()	Блокирует текущий поток до тех пор, пока не будет задано CountdownEvent значение.
Wait(CancellationToken)	Блокирует текущий поток до тех пор, пока не CountdownEvent будет задано, при наблюдении за ней CancellationToken.
Wait(Int32, CancellationToken)	Блокирует текущий поток до CountdownEvent установки, используя 32-разрядное целое число со знаком для измерения времени ожидания, наблюдая за ней CancellationToken.
Wait(Int32)	Блокирует текущий поток до CountdownEvent установки, используя 32-разрядное целое число со знаком для измерения времени ожидания.
Wait(TimeSpan, CancellationToken)	Блокирует текущий поток до тех пор, пока не CountdownEvent будет задано, с помощью TimeSpan измерения времени ожидания при наблюдении за ней CancellationToken.
Wait(TimeSpan)	Блокирует текущий поток до тех пор, пока не CountdownEvent будет задано значение, используя TimeSpan для измерения времени ожидания.

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

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

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

• CountdownEvent