CancellationToken CancellationToken CancellationToken CancellationToken Struct

Definition

Gibt eine Benachrichtigung darüber weiter, dass Vorgänge abgebrochen werden sollen. Propagates notification that operations should be canceled.

public value class CancellationToken
[System.Runtime.InteropServices.ComVisible(false)]
public struct CancellationToken
type CancellationToken = struct
Public Structure CancellationToken
Vererbung
CancellationTokenCancellationTokenCancellationTokenCancellationToken
Attribute

Beispiele

Im folgenden Beispiel wird einen Zufallszahlen-Generator, um eine Anwendung zur Auflistung zu emulieren, die 10 ganzzahlige Werten aus elf Instrumente liest.The following example uses a random number generator to emulate a data collection application that reads 10 integral values from eleven different instruments. Der Wert 0 (null) gibt an, dass die Maßeinheit für eine Instrumentierung fehlgeschlagen ist in diesem Fall der Vorgang abgebrochen werden soll und keine allgemeinen Mittelwert berechnet werden soll.A value of zero indicates that the measurement has failed for one instrument, in which case the operation should be cancelled and no overall mean should be computed.

Um den möglichen Abbruch des Vorgangs zu behandeln, instanziiert das Beispiel ein CancellationTokenSource -Objekt, das ein Abbruchtoken wird, die generiert an eine TaskFactory Objekt.To handle the possible cancellation of the operation, the example instantiates a CancellationTokenSource object that generates a cancellation token which is passed to a TaskFactory object. Die TaskFactory Objekt wiederum übergibt das Abbruchtoken, das auf die einzelnen Aufgaben verantwortlich für das Sammeln von Messwerten für einen bestimmten instrumentieren.The TaskFactory object in turn passes the cancellation token to each of the tasks responsible for collecting readings for a particular instrument. Die TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken) Methode wird aufgerufen, um sicherzustellen, dass der Mittelwert berechnet wird, nur, nachdem alle Messungen erfolgreich erfasst wurden.The TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken) method is called to ensure that the mean is computed only after all readings have been gathered successfully. Wenn eine Aufgabe nicht abgebrochen wurde, dann löst der Aufruf an die Methode TaskFactory.ContinueWhenAll eine Ausnahme aus.If a task has not because it has been cancelled, the call to the TaskFactory.ContinueWhenAll method throws an exception.

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

Ein CancellationToken ermöglicht einen kooperativen Abbruch zwischen Arbeitsaufgaben im Threadpool, Threads oder Task Objekte.A CancellationToken enables cooperative cancellation between threads, thread pool work items, or Task objects. Sie erstellen ein Abbruchtoken, das durch die Instanziierung einer CancellationTokenSource -Objekt, das Abbruchtoken verwaltet abgerufen, von der CancellationTokenSource.Token Eigenschaft.You create a cancellation token by instantiating a CancellationTokenSource object, which manages cancellation tokens retrieved from its CancellationTokenSource.Token property. Übergeben Sie dann das Abbruchtoken, das auf eine beliebige Anzahl von Threads, Tasks oder Vorgänge, die über den Abbruch empfangen soll.You then pass the cancellation token to any number of threads, tasks, or operations that should receive notice of cancellation. Das Token kann nicht verwendet werden, um die Kündigung einzuleiten.The token cannot be used to initiate cancellation. Wenn das besitzende Objekt aufruft CancellationTokenSource.Cancel, IsCancellationRequested auf jede Kopie des Abbruchtokens-Eigenschaftensatz auf true.When the owning object calls CancellationTokenSource.Cancel, the IsCancellationRequested property on every copy of the cancellation token is set to true. Die Objekte, die die Benachrichtigung erhalten, können in jede beliebige Weise reagieren.The objects that receive the notification can respond in whatever manner is appropriate.

Weitere Informationen und Codebeispiele finden Sie unter Abbruch in verwalteten Threads.For more information and code examples see Cancellation in Managed Threads.

Konstruktoren

CancellationToken(Boolean) CancellationToken(Boolean) CancellationToken(Boolean) CancellationToken(Boolean)

Initialisiert das CancellationToken. Initializes the CancellationToken.

Eigenschaften

CanBeCanceled CanBeCanceled CanBeCanceled CanBeCanceled

Ruft einen Wert ab, der angibt, ob der Zustand "abgebrochen" von diesem Token unterstützt wird. Gets whether this token is capable of being in the canceled state.

IsCancellationRequested IsCancellationRequested IsCancellationRequested IsCancellationRequested

Ruft einen Wert ab, der angibt, ob für dieses Token ein Abbruch angefordert wurde. Gets whether cancellation has been requested for this token.

None None None None

Gibt einen leeren CancellationToken-Wert zurück. Returns an empty CancellationToken value.

WaitHandle WaitHandle WaitHandle WaitHandle

Ruft ein WaitHandle ab, das signalisiert wird, wenn das Token abgebrochen wird. Gets a WaitHandle that is signaled when the token is canceled.

Methoden

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Ermittelt, ob die aktuelle CancellationToken-Instanz und die angegebene Object-Instanz gleich sind. Determines whether the current CancellationToken instance is equal to the specified Object.

Equals(CancellationToken) Equals(CancellationToken) Equals(CancellationToken) Equals(CancellationToken)

Ermittelt, ob die aktuelle CancellationToken-Instanz gleich dem angegebenen Token ist. Determines whether the current CancellationToken instance is equal to the specified token.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Dient als Hashfunktion für eine CancellationToken. Serves as a hash function for a CancellationToken.

Register(Action) Register(Action) Register(Action) Register(Action)

Registriert einen Delegaten, der aufgerufen wird, wenn dieses CancellationToken abgebrochen wird. Registers a delegate that will be called when this CancellationToken is canceled.

Register(Action, Boolean) Register(Action, Boolean) Register(Action, Boolean) Register(Action, Boolean)

Registriert einen Delegaten, der aufgerufen wird, wenn dieses CancellationToken abgebrochen wird. Registers a delegate that will be called when this CancellationToken is canceled.

Register(Action<Object>, Object) Register(Action<Object>, Object) Register(Action<Object>, Object) Register(Action<Object>, Object)

Registriert einen Delegaten, der aufgerufen wird, wenn dieses CancellationToken abgebrochen wird. Registers a delegate that will be called when this CancellationToken is canceled.

Register(Action<Object>, Object, Boolean) Register(Action<Object>, Object, Boolean) Register(Action<Object>, Object, Boolean) Register(Action<Object>, Object, Boolean)

Registriert einen Delegaten, der aufgerufen wird, wenn dieses CancellationToken abgebrochen wird. Registers a delegate that will be called when this CancellationToken is canceled.

ThrowIfCancellationRequested() ThrowIfCancellationRequested() ThrowIfCancellationRequested() ThrowIfCancellationRequested()

Löst eine OperationCanceledException aus, wenn für dieses Token ein Abbruch angefordert wurde. Throws a OperationCanceledException if this token has had cancellation requested.

Operatoren

Equality(CancellationToken, CancellationToken) Equality(CancellationToken, CancellationToken) Equality(CancellationToken, CancellationToken) Equality(CancellationToken, CancellationToken)

Stellt fest, ob zwei CancellationToken-Instanzen gleich sind. Determines whether two CancellationToken instances are equal.

Inequality(CancellationToken, CancellationToken) Inequality(CancellationToken, CancellationToken) Inequality(CancellationToken, CancellationToken) Inequality(CancellationToken, CancellationToken)

Ermittelt, ob zwei CancellationToken-Instanzen ungleich sind. Determines whether two CancellationToken instances are not equal.

Gilt für:

Threadsicherheit

Alle öffentlichen und geschützten Member der CancellationToken sind threadsicher und können von mehreren Threads gleichzeitig verwendet werden. All public and protected members of CancellationToken are thread-safe and may be used concurrently from multiple threads.

Siehe auch