CancellationTokenSource Klasse

Definition

Namespace:

System.Threading

Assembly:

System.Runtime.dll

Quelle:

CancellationTokenSource.cs

Signalisiert eine CancellationToken, dass sie abgebrochen werden soll.

public ref class CancellationTokenSource : IDisposable

public class CancellationTokenSource : IDisposable

type CancellationTokenSource = class
    interface IDisposable

Public Class CancellationTokenSource
Implements IDisposable

Vererbung

Object

CancellationTokenSource

Implementiert

IDisposable

Beispiele

Im folgenden Beispiel wird ein Zufallszahlengenerator verwendet, um eine Datensammlungsanwendung zu emulieren, die 10 integrale Werte aus elf verschiedenen Instrumenten liest. Ein Wert von Null gibt an, dass die Messung für ein Instrument fehlgeschlagen ist. In diesem Fall sollte der Vorgang abgebrochen werden und kein Gesamtmittelwert berechnet werden.

Um den möglichen Abbruch des Vorgangs zu behandeln, instanziiert das Beispiel ein CancellationTokenSource-Objekt, das ein Abbruchtoken generiert, das an ein TaskFactory-Objekt übergeben wird. Das TaskFactory-Objekt übergibt wiederum das Abbruchtoken an jede der Aufgaben, die für das Sammeln von Lesevorgängen für ein bestimmtes Instrument verantwortlich sind. Die TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken)-Methode wird aufgerufen, um sicherzustellen, dass der Mittelwert erst berechnet wird, nachdem alle Messwerte erfolgreich gesammelt wurden. Wenn eine Aufgabe nicht abgeschlossen wurde, weil sie abgebrochen wurde, löst der Aufruf der TaskFactory.ContinueWhenAll-Methode eine Ausnahme aus.

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      // Define the cancellation token.
      CancellationTokenSource source = new CancellationTokenSource();
      CancellationToken token = source.Token;

      Random rnd = new Random();
      Object lockObj = new Object();
      
      List<Task<int[]>> tasks = new List<Task<int[]>>();
      TaskFactory factory = new TaskFactory(token);
      for (int taskCtr = 0; taskCtr <= 10; taskCtr++) {
         int iteration = taskCtr + 1;
         tasks.Add(factory.StartNew( () => {
           int value;
           int[] values = new int[10];
           for (int ctr = 1; ctr <= 10; ctr++) {
              lock (lockObj) {
                 value = rnd.Next(0,101);
              }
              if (value == 0) { 
                 source.Cancel();
                 Console.WriteLine("Cancelling at task {0}", iteration);
                 break;
              }   
              values[ctr-1] = value; 
           }
           return values;
        }, token));   
      }
      try {
         Task<double> fTask = factory.ContinueWhenAll(tasks.ToArray(), 
         (results) => {
            Console.WriteLine("Calculating overall mean...");
            long sum = 0;
            int n = 0; 
            foreach (var t in results) {
               foreach (var r in t.Result) {
                  sum += r;
                  n++;
               }
            }
            return sum/(double) n;
         } , token);
         Console.WriteLine("The mean is {0}.", fTask.Result);
      }   
      catch (AggregateException ae) {
         foreach (Exception e in ae.InnerExceptions) {
            if (e is TaskCanceledException)
               Console.WriteLine("Unable to compute mean: {0}", 
                  ((TaskCanceledException) e).Message);
            else
               Console.WriteLine("Exception: " + e.GetType().Name);
         }
      }
      finally {
         source.Dispose();
      }
   }
}
// Repeated execution of the example produces output like the following:
//       Cancelling at task 5
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 10
//       Unable to compute mean: A task was canceled.
//       
//       Calculating overall mean...
//       The mean is 5.29545454545455.
//       
//       Cancelling at task 4
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 5
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 6
//       Unable to compute mean: A task was canceled.
//       
//       Calculating overall mean...
//       The mean is 4.97363636363636.
//       
//       Cancelling at task 4
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 5
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 4
//       Unable to compute mean: A task was canceled.
//       
//       Calculating overall mean...
//       The mean is 4.86545454545455.

Imports System.Collections.Generic
Imports System.Threading
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      ' Define the cancellation token.
      Dim source As New CancellationTokenSource()
      Dim token As CancellationToken = source.Token

      Dim lockObj As New Object()
      Dim rnd As New Random

      Dim tasks As New List(Of Task(Of Integer()))
      Dim factory As New TaskFactory(token)
      For taskCtr As Integer = 0 To 10
         Dim iteration As Integer = taskCtr + 1
         tasks.Add(factory.StartNew(Function()
                                       Dim value, values(9) As Integer
                                       For ctr As Integer = 1 To 10
                                          SyncLock lockObj
                                             value = rnd.Next(0,101)
                                          End SyncLock
                                          If value = 0 Then 
                                             source.Cancel
                                             Console.WriteLine("Cancelling at task {0}", iteration)
                                             Exit For
                                          End If   
                                          values(ctr-1) = value 
                                       Next
                                       Return values
                                    End Function, token))   
         
      Next
      Try
         Dim fTask As Task(Of Double) = factory.ContinueWhenAll(tasks.ToArray(), 
                                                         Function(results)
                                                            Console.WriteLine("Calculating overall mean...")
                                                            Dim sum As Long
                                                            Dim n As Integer 
                                                            For Each t In results
                                                               For Each r In t.Result
                                                                  sum += r
                                                                  n+= 1
                                                               Next
                                                            Next
                                                            Return sum/n
                                                         End Function, token)
         Console.WriteLine("The mean is {0}.", fTask.Result)
      Catch ae As AggregateException
         For Each e In ae.InnerExceptions
            If TypeOf e Is TaskCanceledException
               Console.WriteLine("Unable to compute mean: {0}", 
                                 CType(e, TaskCanceledException).Message)
            Else
               Console.WriteLine("Exception: " + e.GetType().Name)
            End If   
         Next
      Finally
         source.Dispose()
      End Try                                                          
   End Sub
End Module
' Repeated execution of the example produces output like the following:
'       Cancelling at task 5
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 10
'       Unable to compute mean: A task was canceled.
'       
'       Calculating overall mean...
'       The mean is 5.29545454545455.
'       
'       Cancelling at task 4
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 5
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 6
'       Unable to compute mean: A task was canceled.
'       
'       Calculating overall mean...
'       The mean is 4.97363636363636.
'       
'       Cancelling at task 4
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 5
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 4
'       Unable to compute mean: A task was canceled.
'       
'       Calculating overall mean...
'       The mean is 4.86545454545455.

Hinweise

Ab .NET Framework 4 verwendet .NET Framework ein einheitliches Modell für den kooperativen Abbruch asynchroner oder lang ausgeführter synchroner Vorgänge mit zwei Objekten:

• Ein CancellationTokenSource-Objekt, das ein Abbruchtoken über seine Token Eigenschaft bereitstellt und eine Abbruchnachricht sendet, indem die Cancel- oder CancelAfter-Methode aufgerufen wird.

• Ein CancellationToken -Objekt, das angibt, ob eine Abbruch angefordert wird.

Das allgemeine Muster für die Implementierung des kooperativen Abbruchmodells lautet:

• Instanziieren Sie ein CancellationTokenSource-Objekt, das abbruchbenachrichtigungen verwaltet und an die einzelnen Abbruchtoken sendet.

• Übergeben Sie das von der CancellationTokenSource.Token-Eigenschaft zurückgegebene Token an jede Aufgabe oder jeden Thread, der auf den Abbruch lauscht.

• Rufen Sie die CancellationToken.IsCancellationRequested-Methode von Vorgängen auf, die das Abbruchtoken empfangen. Stellen Sie einen Mechanismus für jede Aufgabe oder jeden Thread bereit, um auf eine Abbruchanforderung zu reagieren. Ob Sie einen Vorgang abbrechen möchten und genau wie Sie es tun, hängt von Ihrer Anwendungslogik ab.

• Rufen Sie die CancellationTokenSource.Cancel-Methode auf, um eine Benachrichtigung über den Abbruch bereitzustellen. Dadurch wird die eigenschaft CancellationToken.IsCancellationRequested für jede Kopie des Abbruchtokens auf truefestgelegt.

• Rufen Sie die Dispose-Methode auf, wenn Sie mit dem CancellationTokenSource-Objekt fertig sind.

Weitere Informationen finden Sie unter Abbruch in verwalteten Threads.

Wichtig

Dieser Typ implementiert die IDisposable Schnittstelle. Wenn Sie die Verwendung einer Instanz des Typs abgeschlossen haben, sollten Sie sie entweder direkt oder indirekt löschen. Rufen Sie zum direkten Löschen des Typs die Dispose-Methode in einem try/finally-Block auf. Verwenden Sie zum indirekten Löschen ein Sprachkonstrukt wie using (in C#) oder Using (in Visual Basic). Weitere Informationen finden Sie im Abschnitt "Verwenden eines Objekts, das IDisposable implementiert", im Thema zur IDisposable Schnittstelle.

Konstruktoren

CancellationTokenSource()	Initialisiert eine neue Instanz der CancellationTokenSource Klasse.
CancellationTokenSource(Int32)	Initialisiert eine neue Instanz der CancellationTokenSource Klasse, die nach der angegebenen Verzögerung in Millisekunden abgebrochen wird.
CancellationTokenSource(TimeSpan)	Initialisiert eine neue Instanz der CancellationTokenSource Klasse, die nach der angegebenen Zeitspanne abgebrochen wird.
CancellationTokenSource(TimeSpan, TimeProvider)	Initialisiert eine neue Instanz der CancellationTokenSource Klasse, die nach dem angegebenen TimeSpanabgebrochen wird.

Eigenschaften

IsCancellationRequested	Ruft ab, ob der Abbruch für diese CancellationTokenSourceangefordert wurde.
Token	Ruft die CancellationToken, die diesem CancellationTokenSourcezugeordnet ist.

Methoden

Cancel()	Kommuniziert eine Anfrage zur Stornierung.
Cancel(Boolean)	Kommuniziert eine Anforderung für den Abbruch und gibt an, ob verbleibende Rückrufe und abbruchfähige Vorgänge verarbeitet werden sollen, wenn eine Ausnahme auftritt.
CancelAfter(Int32)	Plant einen Abbruchvorgang für diese CancellationTokenSource nach der angegebenen Anzahl von Millisekunden.
CancelAfter(TimeSpan)	Plant einen Abbruchvorgang auf diesem CancellationTokenSource nach der angegebenen Zeitspanne.
CancelAsync()	Kommuniziert asynchron eine Anforderung für den Abbruch.
CreateLinkedTokenSource(CancellationToken)	Erstellt eine CancellationTokenSource, die sich im abgebrochenen Zustand befindet, wenn sich das angegebene Token im abgebrochenen Zustand befindet.
CreateLinkedTokenSource(CancellationToken, CancellationToken)	Erstellt eine CancellationTokenSource, die sich im Zustand "Abgebrochen" befindet, wenn sich eines der Quelltoken im abgebrochenen Zustand befindet.
CreateLinkedTokenSource(CancellationToken[])	Erstellt eine CancellationTokenSource, die sich im abgebrochenen Zustand befindet, wenn sich eines der Quelltoken im angegebenen Array im abgebrochenen Zustand befindet.
Dispose()	Gibt alle Ressourcen frei, die von der aktuellen Instanz der CancellationTokenSource Klasse verwendet werden.
Dispose(Boolean)	Gibt die nicht verwalteten Ressourcen frei, die von der CancellationTokenSource Klasse verwendet werden, und gibt optional die verwalteten Ressourcen frei.
Equals(Object)	Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht. (Geerbt von Object)
GetHashCode()	Dient als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft die Type der aktuellen Instanz ab. (Geerbt von Object)
MemberwiseClone()	Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)
TryReset()	Versucht, die CancellationTokenSource zurückzusetzen, die für einen nicht verknüpften Vorgang verwendet werden sollen.

Threadsicherheit

Alle öffentlichen und geschützten Member von CancellationTokenSource sind threadsicher und können gleichzeitig aus mehreren Threads verwendet werden, mit Ausnahme von Dispose(), die nur verwendet werden müssen, wenn alle anderen Vorgänge des CancellationTokenSource-Objekts abgeschlossen sind.

Weitere Informationen

• Vorgangsabbruch