CountdownEvent CountdownEvent CountdownEvent CountdownEvent Class

Définition

Représente une primitive de synchronisation qui est signalée lorsque son décompte atteint zéro.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
Héritage
CountdownEventCountdownEventCountdownEventCountdownEvent
Attributs
Implémente

Exemples

L’exemple suivant montre comment utiliser un 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

Constructeurs

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

Initialise une nouvelle instance de la classe CountdownEvent à l'aide du décompte spécifié.Initializes a new instance of CountdownEvent class with the specified count.

Propriétés

CurrentCount CurrentCount CurrentCount CurrentCount

Obtient le nombre de signaux restants requis pour définir l'événement.Gets the number of remaining signals required to set the event.

InitialCount InitialCount InitialCount InitialCount

Obtient le nombre de signaux initialement requis pour définir l'événement.Gets the numbers of signals initially required to set the event.

IsSet IsSet IsSet IsSet

Indique si le nombre actuel de l’objet CountdownEvent a atteint zéro.Indicates whether the CountdownEvent object's current count has reached zero.

WaitHandle WaitHandle WaitHandle WaitHandle

Obtient un WaitHandle qui est utilisé pour attendre l'événement à définir.Gets a WaitHandle that is used to wait for the event to be set.

Méthodes

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

Incrémente de un le décompte actuel de CountdownEvent.Increments the CountdownEvent's current count by one.

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

Incrémente d'une valeur spécifiée le décompte actuel de CountdownEvent.Increments the CountdownEvent's current count by a specified value.

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

Libère toutes les ressources utilisées par l'instance actuelle de la classe CountdownEvent.Releases all resources used by the current instance of the CountdownEvent class.

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

Libère les ressources non managées utilisées par le CountdownEvent, et libère éventuellement les ressources managées.Releases the unmanaged resources used by the CountdownEvent, and optionally releases the managed resources.

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

Détermine si l'objet spécifié est identique à l'objet actuel.Determines whether the specified object is equal to the current object.

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

Fait office de fonction de hachage par défaut.Serves as the default hash function.

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

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

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

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

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

Réinitialise CurrentCount avec la valeur InitialCount.Resets the CurrentCount to the value of InitialCount.

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

Définit la propriété InitialCount spécifiée sur la valeur indiquée.Resets the InitialCount property to a specified value.

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

Enregistre un signal avec le CountdownEvent, en décrémentant la valeur de CurrentCount.Registers a signal with the CountdownEvent, decrementing the value of CurrentCount.

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

Inscrit plusieurs signaux avec CountdownEvent, en décrémentant la valeur de CurrentCount selon la valeur spécifiée.Registers multiple signals with the CountdownEvent, decrementing the value of CurrentCount by the specified amount.

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

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

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

Essaie d'incrémenter CurrentCount par un.Attempts to increment CurrentCount by one.

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

Essaie d'incrémenter CurrentCount par une valeur spécifiée.Attempts to increment CurrentCount by a specified value.

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

Bloque le thread actuel jusqu'à ce que CountdownEvent soit défini.Blocks the current thread until the CountdownEvent is set.

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

Bloque le thread actuel jusqu'à ce que CountdownEvent soit défini, tout en observant un CancellationToken.Blocks the current thread until the CountdownEvent is set, while observing a CancellationToken.

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

Bloque le thread actuel jusqu'à ce que le CountdownEvent soit défini, à l'aide d'un entier signé 32 bits permettant de mesurer le délai d'attente.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)

Bloque le thread actuel jusqu'à ce que CountdownEvent soit défini, à l'aide d'un entier signé 32 bits permettant de mesurer le délai d'attente, tout en observant un 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)

Bloque le thread actuel jusqu'à ce que le CountdownEvent soit défini, à l'aide d'un TimeSpan permettant de mesurer le délai d'attente.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)

Bloque le thread actuel jusqu'à ce que le CountdownEvent soit défini, à l'aide d'un TimeSpan permettant de mesurer le délai d'attente, tout en observant un CancellationToken.Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout, while observing a CancellationToken.

S’applique à

Cohérence de thread

Tous les membres publics et protégés CountdownEvent de sont thread-safe et peuvent être utilisés simultanément à partir de plusieurs threads, à l' Dispose()exception de, qui ne doit être utilisé que lorsque toutes les CountdownEvent autres opérations sur le sont terminées, et Reset(), qui doit être utilisé uniquement quand aucun autre thread n’accède à l’événement.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.

Voir aussi