CountdownEvent Classe

  • Référence

Définition

Espace de noms:
System.Threading
Assembly:
System.Threading.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll

Représente une primitive de synchronisation qui est signalée lorsque son décompte atteint zéro.

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
Héritage
Object
CountdownEvent
Attributs
ComVisibleAttribute
Implémente
IDisposable

Exemples

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

Constructeurs

CountdownEvent(Int32)

Initialise une nouvelle instance de la classe CountdownEvent à l'aide du décompte spécifié.

Propriétés

CurrentCount

Obtient le nombre de signaux restants requis pour définir l'événement.
InitialCount

Obtient le nombre de signaux initialement requis pour définir l'événement.
IsSet

Indique si le nombre actuel de l’objet CountdownEvent a atteint zéro.
WaitHandle

Obtient un WaitHandle qui est utilisé pour attendre l'événement à définir.

Méthodes

AddCount()

Incrémente de un le décompte actuel de CountdownEvent.
AddCount(Int32)

Incrémente d'une valeur spécifiée le décompte actuel de CountdownEvent.
Dispose()

Libère toutes les ressources utilisées par l'instance actuelle de la classe CountdownEvent.
Dispose(Boolean)

Libère les ressources non managées utilisées par le CountdownEvent, et libère éventuellement les ressources managées.
Equals(Object)

Détermine si l'objet spécifié est égal à l'objet actuel.

(Hérité de Object)
GetHashCode()

Fait office de fonction de hachage par défaut.

(Hérité de Object)
GetType()

Obtient le Type de l'instance actuelle.

(Hérité de Object)
MemberwiseClone()

Crée une copie superficielle du Object actuel.

(Hérité de Object)
Reset()

Réinitialise CurrentCount avec la valeur InitialCount.
Reset(Int32)

Définit la propriété InitialCount spécifiée sur la valeur indiquée.
Signal()

Enregistre un signal avec le CountdownEvent, en décrémentant la valeur de CurrentCount.
Signal(Int32)

Inscrit plusieurs signaux avec CountdownEvent, en décrémentant la valeur de CurrentCount selon la valeur spécifiée.
ToString()

Retourne une chaîne qui représente l'objet actuel.

(Hérité de Object)
TryAddCount()

Essaie d'incrémenter CurrentCount par un.
TryAddCount(Int32)

Essaie d'incrémenter CurrentCount par une valeur spécifiée.
Wait()

Bloque le thread actuel jusqu'à ce que CountdownEvent soit défini.
Wait(CancellationToken)

Bloque le thread actuel jusqu'à ce que CountdownEvent soit défini, tout en observant un CancellationToken.
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.
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.
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.
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.

S’applique à

Cohérence de thread

Tous les membres publics et protégés d’entre CountdownEvent eux sont thread-safe et peuvent être utilisés simultanément à partir de plusieurs threads, à l’exception de Dispose(), qui ne doit être utilisé que lorsque toutes les autres opérations sur le site CountdownEvent sont terminées, et Reset()qui ne doit être utilisée que lorsqu’aucun autre thread n’accède à l’événement.

Voir aussi