CountdownEvent Класс
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представляет примитив синхронизации, которому отправляется сигнал при достижении счетчиком нуля.
В этой статье
public ref class CountdownEvent : IDisposable
public class CountdownEvent : IDisposable
[System.Runtime.InteropServices.ComVisible(false)]
public class CountdownEvent : IDisposable
type CountdownEvent = class
interface IDisposable
[<System.Runtime.InteropServices.ComVisible(false)>]
type CountdownEvent = class
interface IDisposable
Public Class CountdownEvent
Implements IDisposable
- Наследование
-
CountdownEvent
- Атрибуты
- Реализации
В следующем примере показано, как использовать следующий 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
Countdown |
Инициализирует новый экземпляр класса CountdownEvent указанным количеством. |
Current |
Получает количество сигналов, оставшееся до установки события. |
Initial |
Получает количество сигналов, изначально нужное для установки события. |
Is |
Указывает, достиг ли текущий счетчик объекта CountdownEvent нуля. |
Wait |
Получает дескриптор WaitHandle, используемый для ожидания установки события. |
Add |
Увеличивает текущий подсчет CountdownEvent на один. |
Add |
Увеличивает текущее количество в объекте CountdownEvent на указанное значение. |
Dispose() |
Освобождает все ресурсы, используемые текущим экземпляром класса CountdownEvent. |
Dispose(Boolean) |
Освобождает неуправляемые ресурсы, используемые журналом CountdownEvent, и при необходимости освобождает также управляемые ресурсы. |
Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
Get |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
Get |
Возвращает объект Type для текущего экземпляра. (Унаследовано от Object) |
Memberwise |
Создает неполную копию текущего объекта Object. (Унаследовано от Object) |
Reset() |
Сбрасывает свойство CurrentCount на значение свойства InitialCount. |
Reset(Int32) |
Присваивает свойству InitialCount заданное значение. |
Signal() |
Регистрирует сигнал с событием CountdownEvent, уменьшая значение свойства CurrentCount. |
Signal(Int32) |
Регистрирует несколько сигналов с объектом CountdownEvent, уменьшая значение свойства CurrentCount на указанное число. |
To |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
Try |
Попытка увеличить CurrentCount на единицу. |
Try |
Пытается увеличить CurrentCount на указанное значение. |
Wait() |
Блокирует текущий поток до установки CountdownEvent. |
Wait(Cancellation |
Блокирует текущий поток, пока не будет установлено CountdownEvent, в то же время контролируя CancellationToken. |
Wait(Int32) |
Блокирует текущий поток до тех пор, пока не установлен объект CountdownEvent, используя 32-разрядное знаковое целое число для измерения времени ожидания. |
Wait(Int32, Cancellation |
Блокирует текущий поток до тех пор, пока не будет установлен объект CountdownEvent, используя 32-разрядное знаковое целое число для измерения времени ожидания. Кроме того, метод контролирует токен CancellationToken. |
Wait(Time |
Блокирует текущий поток до тех пор, пока не будет установлен объект CountdownEvent, используя значение TimeSpan для измерения времени ожидания. |
Wait(Time |
Блокирует текущий поток, пока не будет установлен объект CountdownEvent, используя значение TimeSpan для измерения времени ожидания. Кроме того, метод контролирует токен CancellationToken. |
Все открытые и защищенные члены CountdownEvent являются потокобезопасными и могут использоваться одновременно из нескольких потоков, за исключением того, что их следует использовать только в том случае Dispose(), если все остальные операции с CountdownEvent ним завершены, и Reset()которые следует использовать только в том случае, если другие потоки не обращаются к событию.