CountdownEvent 类

定义

命名空间:

System.Threading

程序集:

System.Threading.dll

程序集:

mscorlib.dll

程序集:

netstandard.dll

表示在计数变为零时处于有信号状态的同步基元。

C#

public class CountdownEvent : IDisposable

C#

[System.Runtime.InteropServices.ComVisible(false)]
public class CountdownEvent : IDisposable

继承

Object

CountdownEvent

属性

ComVisibleAttribute

实现

IDisposable

示例

以下示例演示如何使用 CountdownEvent：

C#

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

构造函数

CountdownEvent(Int32)

使用指定计数初始化 CountdownEvent 类的新实例。

属性

CurrentCount	获取设置事件时所必需的剩余信号数。
InitialCount	获取设置事件时最初必需的信号数。
IsSet	表示 CountdownEvent 对象的当前计数是否已归零。
WaitHandle	获取用于等待要设置的事件的 WaitHandle。

方法

AddCount()	将 CountdownEvent 的当前计数加 1。
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)	阻止当前线程，直到设置了 CountdownEvent 为止，同时使用 32 位带符号整数测量超时。
Wait(Int32, CancellationToken)	阻止当前线程，直到设置了 CountdownEvent 为止，并使用 32 位带符号整数测量超时，同时观察 CancellationToken。
Wait(TimeSpan)	阻止当前线程，直到设置了 CountdownEvent 为止，同时使用 TimeSpan 测量超时。
Wait(TimeSpan, CancellationToken)	阻止当前线程，直到设置了 CountdownEvent 为止，并使用 TimeSpan 测量超时，同时观察 CancellationToken。

适用于

线程安全性

所有公共成员和受保护的成员CountdownEvent都是线程安全的，并且可能同时从多个线程使用，但例外是，只有在Dispose()已完成所有其他操作CountdownEventReset()时才使用，并且仅在没有其他线程访问事件时才使用。

另请参阅

• CountdownEvent