CancellationToken Structure

Définition

Espace de noms:

System.Threading

Assembly:

System.Threading.Tasks.dll

Assembly:

System.Runtime.dll

Assembly:

mscorlib.dll

Assembly:

netstandard.dll

Propage une notification indiquant que des opérations doivent être annulées.

C#

public struct CancellationToken

C#

public readonly struct CancellationToken

C#

public readonly struct CancellationToken : IEquatable<System.Threading.CancellationToken>

C#

[System.Runtime.InteropServices.ComVisible(false)]
public struct CancellationToken

Héritage

Object

ValueType

CancellationToken

Attributs

ComVisibleAttribute

Implémente

IEquatable<CancellationToken>

Exemples

L’exemple suivant utilise un générateur de nombres aléatoires pour émuler une application de collecte de données qui lit 10 valeurs intégrales à partir de onze instruments différents. La valeur zéro indique que la mesure a échoué pour un instrument, auquel cas l’opération doit être annulée et aucune moyenne globale ne doit être calculée.

Pour gérer l’annulation possible de l’opération, l’exemple instancie un CancellationTokenSource objet qui génère un jeton d’annulation passé à un TaskFactory objet. À son tour, l’objet TaskFactory transmet le jeton d’annulation à chacune des tâches responsables de la collecte de lectures pour un instrument particulier. La TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken) méthode est appelée pour s’assurer que la moyenne est calculée uniquement après que toutes les lectures ont été collectées avec succès. Si une tâche n’est pas terminée, car elle a été annulée, la TaskFactory.ContinueWhenAll méthode lève une exception.

C#

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.

Remarques

Une CancellationToken option active l’annulation coopérative entre les threads, les éléments de travail du pool de threads ou Task les objets. Vous créez un jeton d’annulation en instanciant un CancellationTokenSource objet, qui gère les jetons d’annulation récupérés à partir de sa CancellationTokenSource.Token propriété. Vous passez ensuite le jeton d’annulation à un nombre quelconque de threads, de tâches ou d’opérations qui doivent recevoir une notification d’annulation. Le jeton ne peut pas être utilisé pour lancer l’annulation. Lorsque l’objet propriétaire appelle CancellationTokenSource.Cancel, la IsCancellationRequested propriété sur chaque copie du jeton d’annulation est définie truesur . Les objets qui reçoivent la notification peuvent répondre de quelque manière que ce soit.

Pour plus d’informations et des exemples de code, consultez Annulation dans les threads managés.

Constructeurs

CancellationToken(Boolean)

Initialise la CancellationToken.

Propriétés

CanBeCanceled	Détermine si ce jeton peut être à l'état Annulé.
IsCancellationRequested	Détermine si l'annulation a été demandée pour ce jeton.
None	Retourne une valeur CancellationToken vide.
WaitHandle	Obtient un WaitHandle qui est signalé lors de l'annulation du jeton.

Méthodes

Equals(CancellationToken)	Détermine si l'instance actuelle de CancellationToken est égale au jeton spécifié.
Equals(Object)	Détermine si l'instance actuelle de CancellationToken est égale au Object spécifié.
GetHashCode()	Sert de fonction de hachage pour un CancellationToken.
Register(Action)	Inscrit un délégué qui sera appelé lors de l'annulation du CancellationToken.
Register(Action, Boolean)	Inscrit un délégué qui sera appelé lors de l'annulation du CancellationToken.
Register(Action<Object,CancellationToken>, Object)	Inscrit un délégué qui sera appelé lorsque ce cancellationToken est annulé.
Register(Action<Object>, Object)	Inscrit un délégué qui sera appelé lors de l'annulation du CancellationToken.
Register(Action<Object>, Object, Boolean)	Inscrit un délégué qui sera appelé lors de l'annulation du CancellationToken.
ThrowIfCancellationRequested()	Lève une OperationCanceledException si l'annulation de ce jeton a été demandée.
UnsafeRegister(Action<Object,CancellationToken>, Object)	Inscrit un délégué qui sera appelé lorsque ce cancellationToken est annulé.
UnsafeRegister(Action<Object>, Object)	Inscrit un délégué qui est appelé quand ce CancellationToken est annulé.

Opérateurs

Equality(CancellationToken, CancellationToken)	Détermine si deux instances CancellationToken sont égales.
Inequality(CancellationToken, CancellationToken)	Détermine si les deux instances de CancellationToken ne sont pas égales.

S’applique à

Cohérence de thread

Tous les membres publics et protégés de CancellationToken sont thread-safe et peuvent être utilisés simultanément par plusieurs threads.

Voir aussi

• Annulation
• Annulation de tâches