CountdownEvent CountdownEvent CountdownEvent CountdownEvent Class

Определение

Представляет примитив синхронизации, которому отправляется сигнал при достижении счетчиком нуля.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 нуля.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 на один.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()

Сбрасывает свойство CurrentCount на значение свойства InitialCount.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 на единицу.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)

Блокирует текущий поток до тех пор, пока не установлен объект CountdownEvent, используя 32-разрядное знаковое целое число для измерения времени ожидания.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.

Дополнительно