CountdownEvent
System.Threading.CountdownEvent ist ein Synchronisierungsgrundelement, für das die Blockierung der wartenden Threads aufgehoben wird, nachdem dies mehrfach signalisiert wurde. CountdownEvent wurde für Szenarios entworfen, in denen sonst ein ManualResetEvent oder ManualResetEventSlim verwendet und vor dem Signalisieren des Ereignisses manuell eine Variable dekrementiert werden müsste. Zum Beispiel kann in einem Verzweigungs-/Verknüpfungsszenario nur ein CountdownEvent-Element mit einer Signalanzahl von 5 erstellt werden. Anschließend können fünf Arbeitsaufgaben im Threadpool gestartet werden, wobei für jede Arbeitsaufgabe bei deren Abschluss Signal aufgerufen werden kann. Durch jeden Aufruf von Signal wird die Signalanzahl um 1 verringert. Auf dem Hauptthread wird der Aufruf von Wait solange blockiert, bis die Signalanzahl 0 (null) beträgt.
.gif "Hinweis") Hinweis |
|---|
Erwägen Sie für Code, der nicht mit älteren .NET Framework-Synchronisierungs-APIs interagieren muss, die Verwendung von System.Threading.Tasks.Task-Objekten und/oder der ParallelInvoke()-Methode, um Verzweigungs-Verknüpfungs-Parallelismus leichter ausdrücken zu können. |
CountdownEvent verfügt über diese zusätzlichen Funktionen:
Der Wartevorgang kann mit Abbruchtokens abgebrochen werden.
Seine Signalanzahl kann nach der Erstellung der Instanz erhöht werden.
Instanzen können nach der Rückgabe von Wait durch den Aufruf der Reset-Methode wiederverwendet werden.
Instanzen stellen ein WaitHandle für die Integration in andere .NET Framework-Synchronisierungs-APIs, wie z. B. WaitAll, bereit.
Grundlegende Verwendung
Das folgende Beispiel veranschaulicht die Verwendung eines CountdownEvent-Elements mit ThreadPool-Arbeitsaufgaben.
Dim source As IEnumerable(Of Data) = GetData()
Dim e = New CountdownEvent(1)
' Fork work:
For Each element As Data In source
' Dynamically increment signal count.
e.AddCount()
ThreadPool.QueueUserWorkItem(Sub(state)
Try
ProcessData(state)
Finally
e.Signal()
End Try
End Sub,
element)
Next
' Decrement the signal count by the one we added
' in the constructor.
e.Signal()
' The first element could also be run on this thread.
' ProcessData(New Data(0))
' Join with work:
e.Wait()
IEnumerable<Data> source = GetData();
using (CountdownEvent e = new CountdownEvent(1))
{
// fork work:
foreach (Data element in source)
{
// Dynamically increment signal count.
e.AddCount();
ThreadPool.QueueUserWorkItem(delegate(object state)
{
try
{
ProcessData(state);
}
finally
{
e.Signal();
}
},
element);
}
e.Signal();
// The first element could be run on this thread.
// Join with work.
e.Wait();
}
// .,.
CountdownEvent mit Abbruch
Das folgende Beispiel veranschaulicht, wie der Wartevorgang für CountdownEvent mit einem Abbruchtoken abgebrochen wird. Das grundlegende Muster folgt dem Modell für einheitlichen Abbruch, der in .NET Framework, Version 4 eingeführt wird. Weitere Informationen finden Sie unter Abbruch.
Option Strict On
Option Explicit On
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Linq
Imports System.Threading
Imports System.Threading.Tasks
Module CancelEventWait
Class Data
Public Num As Integer
Public Sub New(ByVal i As Integer)
Num = i
End Sub
Public Sub New()
End Sub
End Class
Class DataWithToken
Public Token As CancellationToken
Public _data As Data
Public Sub New(ByVal d As Data, ByVal ct As CancellationToken)
Me._data = d
Me.Token = ct
End Sub
End Class
Class Program
Shared Function GetData() As IEnumerable(Of Data)
Dim nums = New List(Of Data)
For i As Integer = 1 To 5
nums.Add(New Data(i))
Next
Return nums
End Function
Shared Sub ProcessData(ByVal obj As Object)
Dim dataItem As DataWithToken = CType(obj, DataWithToken)
If dataItem.Token.IsCancellationRequested = True Then
Console.WriteLine("Canceled before starting {0}", dataItem._data.Num)
Exit Sub
End If
' Increase this value to slow down the program.
For i As Integer = 0 To 10000
If dataItem.Token.IsCancellationRequested = True Then
Console.WriteLine("Cancelling while executing {0}", dataItem._data.Num)
Exit Sub
End If
Thread.SpinWait(100000)
Next
Console.WriteLine("Processed {0}", dataItem._data.Num)
End Sub
Shared Sub Main()
DoEventWithCancel()
Console.WriteLine("Press the enter key to exit.")
Console.ReadLine()
End Sub
Shared Sub DoEventWithCancel()
Dim source As IEnumerable(Of Data) = GetData()
Dim cts As CancellationTokenSource = New CancellationTokenSource()
' Enable cancellation request from a simple UI thread.
Task.Factory.StartNew(Sub()
If Console.ReadKey().KeyChar = "c"c Then
cts.Cancel()
End If
End Sub)
' Must have a count of at least 1 or else it is signaled.
Dim e As CountdownEvent = New CountdownEvent(1)
For Each element As Data In source
Dim item As DataWithToken = New DataWithToken(element, cts.Token)
' Dynamically increment signal count.
e.AddCount()
ThreadPool.QueueUserWorkItem(Sub(state)
ProcessData(state)
If cts.Token.IsCancellationRequested = False Then
e.Signal()
End If
End Sub,
item)
Next
' Decrement the signal count by the one we added
' in the constructor.
e.Signal()
' The first element could be run on this thread.
' ProcessData(source(0))
' Join with work or catch cancellation exception
Try
e.Wait(cts.Token)
Catch ex As OperationCanceledException
If ex.CancellationToken = cts.Token Then
Console.WriteLine("User canceled.")
Else : Throw ' we don't know who canceled us.
End If
End Try
End Sub
End Class
End Module
class CancelableCountdowEvent
{
class Data
{
public int Num { get; set; }
public Data(int i) { Num = i; }
public Data() { }
}
class DataWithToken
{
public CancellationToken Token { get; set; }
public Data Data { get; private set; }
public DataWithToken(Data data, CancellationToken ct)
{
this.Data = data;
this.Token = ct;
}
}
static IEnumerable<Data> GetData()
{
return new List<Data>() { new Data(1), new Data(2), new Data(3), new Data(4), new Data(5) };
}
static void ProcessData(object obj)
{
DataWithToken dataWithToken = (DataWithToken)obj;
if (dataWithToken.Token.IsCancellationRequested)
{
Console.WriteLine("Canceled before starting {0}", dataWithToken.Data.Num);
return;
}
for (int i = 0; i < 10000; i++)
{
if (dataWithToken.Token.IsCancellationRequested)
{
Console.WriteLine("Cancelling while executing {0}", dataWithToken.Data.Num);
return;
}
// Increase this value to slow down the program.
Thread.SpinWait(100000);
}
Console.WriteLine("Processed {0}", dataWithToken.Data.Num);
}
static void Main(string[] args)
{
EventWithCancel();
Console.WriteLine("Press enter to exit.");
Console.ReadLine();
}
static void EventWithCancel()
{
IEnumerable<Data> source = GetData();
CancellationTokenSource cts = new CancellationTokenSource();
//Enable cancellation request from a simple UI thread.
Task.Factory.StartNew(() =>
{
if (Console.ReadKey().KeyChar == 'c')
cts.Cancel();
});
// Event must have a count of at least 1
CountdownEvent e = new CountdownEvent(1);
// fork work:
foreach (Data element in source)
{
DataWithToken item = new DataWithToken(element, cts.Token);
// Dynamically increment signal count.
e.AddCount();
ThreadPool.QueueUserWorkItem(delegate(object state)
{
ProcessData(state);
if (!cts.Token.IsCancellationRequested)
e.Signal();
},
item);
}
// Decrement the signal count by the one we added
// in the constructor.
e.Signal();
// The first element could be run on this thread.
// Join with work or catch cancellation.
try
{
e.Wait(cts.Token);
}
catch (OperationCanceledException oce)
{
if (oce.CancellationToken == cts.Token)
{
Console.WriteLine("User canceled.");
}
else throw; //We don't know who canceled us!
}
e.Dispose();
//...
} //end method
} //end class
Beachten Sie, dass vom Wartevorgang nicht die Threads abgebrochen werden, die den Wartevorgang signalisieren. In der Regel wird eine logische Operation abgebrochen. Hierzu zählen das Warten auf das Ereignis sowie alle Arbeitsaufgaben, die vom Wartevorgang synchronisiert werden. In diesem Beispiel wird jeder Arbeitsaufgabe eine Kopie des gleichen Abbruchtokens übergeben, damit auf die Abbruchanforderung reagiert werden kann.
Siehe auch
Weitere Ressourcen
EventWaitHandle, AutoResetEvent, CountdownEvent und ManualResetEvent