CountdownEvent Třída

Definice

Obor názvů:

System.Threading

Sestavení:

netstandard.dll, System.Threading.dll

Zdroj:

CountdownEvent.cs

Představuje primitivní synchronizaci, která je signalována, když jeho počet dosáhne nuly.

public ref class CountdownEvent : IDisposable

public class CountdownEvent : IDisposable

type CountdownEvent = class
    interface IDisposable

Public Class CountdownEvent
Implements IDisposable

Dědičnost

Object

CountdownEvent

Implementuje

IDisposable

Příklady

Následující příklad ukazuje, jak použít 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

Konstruktory

Name	Description
CountdownEvent(Int32)	Inicializuje novou instanci CountdownEvent třídy se zadaným počtem.

Vlastnosti

Name	Description
CurrentCount	Získá počet zbývajících signálů potřebných k nastavení události.
InitialCount	Získá počet signálů původně vyžadovaných k nastavení události.
IsSet	Určuje, jestli aktuální počet objektu CountdownEvent dosáhl nuly.
WaitHandle	WaitHandle Získá hodnotu, která se používá k čekání na nastavení události.

Metody

Name	Description
AddCount()	Zvýší CountdownEventaktuální počet o jeden.
AddCount(Int32)	Zvýší CountdownEventaktuální počet o zadanou hodnotu.
Dispose()	Uvolní všechny prostředky používané aktuální instancí CountdownEvent třídy.
Dispose(Boolean)	Uvolní nespravované prostředky používané CountdownEventnástrojem a volitelně uvolní spravované prostředky.
Equals(Object)	Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí funkce hash. (Zděděno od Object)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
Reset()	CurrentCount Obnoví hodnotu InitialCount.
Reset(Int32)	InitialCount Obnoví vlastnost na zadanou hodnotu.
Signal()	Zaregistruje signál s CountdownEventdekrementací hodnoty CurrentCount.
Signal(Int32)	Zaregistruje více signálů s CountdownEventdekrementací hodnoty CurrentCount o zadanou částku.
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)
TryAddCount()	Pokusí se zvýšit CurrentCount o jeden.
TryAddCount(Int32)	Pokusí se zvýšit CurrentCount o zadanou hodnotu.
Wait()	Zablokuje aktuální vlákno, dokud se nenastaví CountdownEvent .
Wait(CancellationToken)	Zablokuje aktuální vlákno, dokud CountdownEvent není nastavena, zatímco pozoruje CancellationToken.
Wait(Int32, CancellationToken)	Blokuje aktuální vlákno, dokud CountdownEvent není nastaveno pomocí 32bitového signed integer k měření časového limitu CancellationTokenpři sledování .
Wait(Int32)	Zablokuje aktuální vlákno, dokud CountdownEvent není nastaveno, pomocí 32bitového signed integer k měření časového limitu.
Wait(TimeSpan, CancellationToken)	Zablokuje aktuální vlákno, dokud CountdownEvent není nastaveno pomocí TimeSpan časového limitu měření při sledování CancellationToken.
Wait(TimeSpan)	Blokuje aktuální vlákno, dokud CountdownEvent se nenastaví, pomocí TimeSpan časového limitu změříte.

Bezpečný přístup z více vláken

Všechny veřejné a chráněné členy CountdownEvent jsou bezpečné pro přístup z více vláken a mohou být používány souběžně z více vláken, s výjimkou Dispose(), které musí být použity pouze v případě, že jsou dokončeny všechny ostatní operace CountdownEvent a Reset(), které by se měly použít pouze v případě, že k události nepřistupují žádná jiná vlákna.

Viz také

• CountdownEvent