CancellationToken Struktur

Definition

Gibt eine Benachrichtigung darüber weiter, dass Vorgänge abgebrochen werden sollen.

public value class CancellationToken
public value class CancellationToken : IEquatable<System::Threading::CancellationToken>
public struct CancellationToken
public readonly struct CancellationToken
public readonly struct CancellationToken : IEquatable<System.Threading.CancellationToken>
[System.Runtime.InteropServices.ComVisible(false)]
public struct CancellationToken
type CancellationToken = struct
[<System.Runtime.InteropServices.ComVisible(false)>]
type CancellationToken = struct
Public Structure CancellationToken
Public Structure CancellationToken
Implements IEquatable(Of CancellationToken)
Vererbung
CancellationToken
Attribute
Implementiert

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 Gesamtwert 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 das Mittel nur berechnet wird, nachdem alle Lesewerte erfolgreich gesammelt wurden. Wenn eine Aufgabe nicht abgeschlossen wurde, weil sie abgebrochen wurde, löst die 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

Eine CancellationToken genossenschaftliche Abbruch zwischen Threads, Threadpoolarbeitselementen oder Task Objekten ermöglicht. Sie erstellen ein Abbruchtoken, indem Sie ein CancellationTokenSource Objekt instanziieren, das Abbruchtoken verwaltet, die von ihrer CancellationTokenSource.Token Eigenschaft abgerufen wurden. Anschließend übergeben Sie das Abbruchtoken an eine beliebige Anzahl von Threads, Vorgängen oder Vorgängen, die eine Kündigungsbenachrichtigung erhalten sollten. Das Token kann nicht zum Initiieren der Abbruch verwendet werden. Wenn das eigene Objekt aufgerufen CancellationTokenSource.Cancelwird, wird die IsCancellationRequested Eigenschaft auf jeder Kopie des Abbruchtokens auf truefestgelegt. Die Objekte, die die Benachrichtigung erhalten, können auf jede Art und Weise reagieren.

Weitere Informationen und Codebeispiele finden Sie unter "Abbruch" in verwalteten Threads.

Konstruktoren

CancellationToken(Boolean)

Initialisiert das CancellationToken.

Eigenschaften

CanBeCanceled

Ruft einen Wert ab, der angibt, ob der Zustand "abgebrochen" von diesem Token unterstützt wird.

IsCancellationRequested

Ruft einen Wert ab, der angibt, ob für dieses Token ein Abbruch angefordert wurde.

None

Gibt einen leeren CancellationToken-Wert zurück.

WaitHandle

Ruft ein WaitHandle ab, das signalisiert wird, wenn das Token abgebrochen wird.

Methoden

Equals(CancellationToken)

Ermittelt, ob die aktuelle CancellationToken-Instanz gleich dem angegebenen Token ist.

Equals(Object)

Ermittelt, ob die aktuelle CancellationToken-Instanz und die angegebene Object-Instanz gleich sind.

GetHashCode()

Dient als Hashfunktion für eine CancellationToken.

Register(Action)

Registriert einen Delegaten, der aufgerufen wird, wenn dieses CancellationToken abgebrochen wird.

Register(Action, Boolean)

Registriert einen Delegaten, der aufgerufen wird, wenn dieses CancellationToken abgebrochen wird.

Register(Action<Object,CancellationToken>, Object)

Registriert eine Stellvertretung, die aufgerufen wird, wenn diese CancelToken abgebrochen wird.

Register(Action<Object>, Object)

Registriert einen Delegaten, der aufgerufen wird, wenn dieses CancellationToken abgebrochen wird.

Register(Action<Object>, Object, Boolean)

Registriert einen Delegaten, der aufgerufen wird, wenn dieses CancellationToken abgebrochen wird.

ThrowIfCancellationRequested()

Löst eine OperationCanceledException aus, wenn für dieses Token ein Abbruch angefordert wurde.

UnsafeRegister(Action<Object,CancellationToken>, Object)

Registriert eine Stellvertretung, die aufgerufen wird, wenn diese CancelToken abgebrochen wird.

UnsafeRegister(Action<Object>, Object)

Registriert einen Delegaten, der aufgerufen wird, wenn dieses CancellationToken abgebrochen wird.

Operatoren

Equality(CancellationToken, CancellationToken)

Stellt fest, ob zwei CancellationToken-Instanzen gleich sind.

Inequality(CancellationToken, CancellationToken)

Ermittelt, ob zwei CancellationToken-Instanzen ungleich sind.

Gilt für:

Threadsicherheit

Alle öffentlichen und geschützten Elemente CancellationToken sind threadsicher und können gleichzeitig von mehreren Threads verwendet werden.

Siehe auch