CountdownEvent Klasa

Definicja

Reprezentuje pierwotną synchronizację, która jest zasygnalizowania, gdy jej licznik osiągnie wartość zero.Represents a synchronization primitive that is signaled when its count reaches zero.

public ref class CountdownEvent : IDisposable
public class CountdownEvent : IDisposable
[System.Runtime.InteropServices.ComVisible(false)]
public class CountdownEvent : IDisposable
type CountdownEvent = class
    interface IDisposable
Public Class CountdownEvent
Implements IDisposable
Dziedziczenie
CountdownEvent
Atrybuty
Implementuje

Przykłady

Poniższy przykład pokazuje, jak używać 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

Konstruktory

CountdownEvent(Int32)

Inicjuje nowe wystąpienie klasy CountdownEvent z określoną liczbą.Initializes a new instance of CountdownEvent class with the specified count.

Właściwości

CurrentCount

Pobiera liczbę pozostałych sygnałów wymaganych do ustawienia zdarzenia.Gets the number of remaining signals required to set the event.

InitialCount

Pobiera liczbę sygnałów wstępnie wymaganych do ustawienia zdarzenia.Gets the numbers of signals initially required to set the event.

IsSet

Wskazuje CountdownEvent, czy bieżąca liczba osiągnęła wartość zerową.Indicates whether the CountdownEvent object's current count has reached zero.

WaitHandle

Pobiera WaitHandle, który jest używany do oczekiwania na ustawienie zdarzenia.Gets a WaitHandle that is used to wait for the event to be set.

Metody

AddCount()

Zwiększa bieżącą liczbę CountdownEvento jeden.Increments the CountdownEvent's current count by one.

AddCount(Int32)

Zwiększa bieżącą liczbę CountdownEventprzez określoną wartość.Increments the CountdownEvent's current count by a specified value.

Dispose()

Zwalnia wszystkie zasoby używane przez bieżące wystąpienie klasy CountdownEvent.Releases all resources used by the current instance of the CountdownEvent class.

Dispose(Boolean)

Zwalnia niezarządzane zasoby używane przez CountdownEventi opcjonalnie zwalnia zarządzane zasoby.Releases the unmanaged resources used by the CountdownEvent, and optionally releases the managed resources.

Equals(Object)

Określa, czy określony obiekt jest równy bieżącemu obiektowi.Determines whether the specified object is equal to the current object.

(Odziedziczone po Object)
GetHashCode()

Służy jako domyślna funkcja skrótu.Serves as the default hash function.

(Odziedziczone po Object)
GetType()

Pobiera Type bieżącego wystąpienia.Gets the Type of the current instance.

(Odziedziczone po Object)
MemberwiseClone()

Tworzy skróconą kopię bieżącego Object.Creates a shallow copy of the current Object.

(Odziedziczone po Object)
Reset()

Resetuje CurrentCount do wartości InitialCount.Resets the CurrentCount to the value of InitialCount.

Reset(Int32)

Resetuje właściwość InitialCount do określonej wartości.Resets the InitialCount property to a specified value.

Signal()

Rejestruje sygnał z CountdownEvent, co zmniejsza wartość CurrentCount.Registers a signal with the CountdownEvent, decrementing the value of CurrentCount.

Signal(Int32)

Rejestruje wiele sygnałów przy użyciu CountdownEvent, co zmniejsza wartość CurrentCount o określoną wartość.Registers multiple signals with the CountdownEvent, decrementing the value of CurrentCount by the specified amount.

ToString()

Zwraca ciąg, który reprezentuje bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)
TryAddCount()

Próbuje zwiększyć CurrentCount o jeden.Attempts to increment CurrentCount by one.

TryAddCount(Int32)

Próbuje zwiększyć CurrentCount przez określoną wartość.Attempts to increment CurrentCount by a specified value.

Wait()

Blokuje bieżący wątek, dopóki CountdownEvent nie zostanie ustawiona.Blocks the current thread until the CountdownEvent is set.

Wait(CancellationToken)

Blokuje bieżący wątek, dopóki CountdownEvent nie zostanie ustawiona, przy zachowaniu CancellationToken.Blocks the current thread until the CountdownEvent is set, while observing a CancellationToken.

Wait(Int32)

Blokuje bieżący wątek do momentu, aż CountdownEvent zostanie ustawiona, przy użyciu 32-bitowej podpisanej liczby całkowitej do mierzenia limitu czasu.Blocks the current thread until the CountdownEvent is set, using a 32-bit signed integer to measure the timeout.

Wait(Int32, CancellationToken)

Blokuje bieżący wątek do momentu, aż CountdownEvent zostanie ustawiona, przy użyciu 32-bitowej podpisanej liczby całkowitej do mierzenia limitu czasu, przy zachowaniu 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)

Blokuje bieżący wątek do momentu ustawienia CountdownEvent przy użyciu TimeSpan do mierzenia limitu czasu.Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout.

Wait(TimeSpan, CancellationToken)

Blokuje bieżący wątek do momentu, gdy CountdownEvent zostanie ustawiona, przy użyciu TimeSpan do mierzenia limitu czasu, przy zachowaniu CancellationToken.Blocks the current thread until the CountdownEvent is set, using a TimeSpan to measure the timeout, while observing a CancellationToken.

Dotyczy

Bezpieczeństwo wątkowe

Wszystkie publiczne i chronione elementy członkowskie CountdownEvent są bezpieczne dla wątków i mogą być używane współbieżnie z wielu wątków, z wyjątkiem Dispose(), które muszą być używane tylko wtedy, gdy wszystkie inne operacje na CountdownEvent zostały ukończone i Reset(), które powinny być używane tylko wtedy, gdy żadne inne wątki nie uzyskują dostępu do zdarzenia.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.

Zobacz też