CancellationToken.IsCancellationRequested Propriété

  • Référence

Définition

Espace de noms:
System.Threading
Assembly:
System.Threading.Tasks.dll
Assembly:
System.Runtime.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll

Détermine si l'annulation a été demandée pour ce jeton.

public:
 property bool IsCancellationRequested { bool get(); };
public bool IsCancellationRequested { get; }
member this.IsCancellationRequested : bool
Public ReadOnly Property IsCancellationRequested As Boolean

Valeur de propriété

Boolean

true si l’annulation a été demandée pour ce jeton ; sinon, false.

Exemples

Voici un exemple simple qui exécute un processus serveur jusqu’à ce que la IsCancellationRequested propriété retourne true.

using System;
using System.Threading;

public class ServerClass
{
   public static void StaticMethod(object obj)
   {
      CancellationToken ct = (CancellationToken)obj;
      Console.WriteLine("ServerClass.StaticMethod is running on another thread.");

      // Simulate work that can be canceled.
      while (!ct.IsCancellationRequested) {
         Thread.SpinWait(50000);
      }
      Console.WriteLine("The worker thread has been canceled. Press any key to exit.");
      Console.ReadKey(true);
   }
}

public class Simple
{
   public static void Main()
   {
      // The Simple class controls access to the token source.
      CancellationTokenSource cts = new CancellationTokenSource();

      Console.WriteLine("Press 'C' to terminate the application...\n");
      // Allow the UI thread to capture the token source, so that it
      // can issue the cancel command.
      Thread t1 = new Thread(() => { if (Console.ReadKey(true).KeyChar.ToString().ToUpperInvariant() == "C")
                                     cts.Cancel(); } );

      // ServerClass sees only the token, not the token source.
      Thread t2 = new Thread(new ParameterizedThreadStart(ServerClass.StaticMethod));
      // Start the UI thread.

      t1.Start();

      // Start the worker thread and pass it the token.
      t2.Start(cts.Token);

      t2.Join();
      cts.Dispose();
   }
}
// The example displays the following output:
//       Press 'C' to terminate the application...
//
//       ServerClass.StaticMethod is running on another thread.
//       The worker thread has been canceled. Press any key to exit.

Imports System.Threading

Public Class ServerClass
   Public Shared Sub StaticMethod(obj As Object)
      Dim ct AS CancellationToken = CType(obj, CancellationToken)
      Console.WriteLine("ServerClass.StaticMethod is running on another thread.")

      ' Simulate work that can be canceled.
      While Not ct.IsCancellationRequested
         Thread.SpinWait(50000)
      End While
      Console.WriteLine("The worker thread has been canceled. Press any key to exit.")
      Console.ReadKey(True)
   End Sub
End Class

Public Class Simple
   Public Shared Sub Main()
      ' The Simple class controls access to the token source.
      Dim cts As New CancellationTokenSource()

      Console.WriteLine("Press 'C' to terminate the application..." + vbCrLf)
      ' Allow the UI thread to capture the token source, so that it
      ' can issue the cancel command.
      Dim t1 As New Thread( Sub()
                               If Console.ReadKey(true).KeyChar.ToString().ToUpperInvariant() = "C" Then
                                  cts.Cancel()
                               End If
                            End Sub)

      ' ServerClass sees only the token, not the token source.
      Dim t2 As New Thread(New ParameterizedThreadStart(AddressOf ServerClass.StaticMethod))

      ' Start the UI thread.
      t1.Start()

      ' Start the worker thread and pass it the token.
      t2.Start(cts.Token)

      t2.Join()
      cts.Dispose()
   End Sub
End Class
' The example displays the following output:
'       Press 'C' to terminate the application...
'
'       ServerClass.StaticMethod is running on another thread.
'       The worker thread has been canceled. Press any key to exit.

L’exemple instancie un CancellationTokenSource objet, qui contrôle l’accès au jeton d’annulation. Il définit ensuite deux procédures de thread. La première est définie comme une expression lambda qui regroupe le clavier et, lorsque la touche « C » est enfoncée, les appels CancellationTokenSource.Cancel pour définir le jeton d’annulation à l’état annulé. La seconde est une méthode paramétrable, ServerClass.StaticMethodqui exécute une boucle jusqu’à ce que la IsCancellationRequested propriété soit true.

Le thread principal démarre ensuite les deux threads et les blocs jusqu’à ce que le thread qui exécute la ServerClass.StaticMethod méthode se termine.

Remarques

Cette propriété indique si l’annulation a été demandée pour ce jeton, soit par le biais du jeton initialement construit dans un état annulé, soit par l’appel Cancel à l’associé CancellationTokenSourcedu jeton.

Si cette propriété est true, elle garantit uniquement que l’annulation a été demandée. Il ne garantit pas que chaque gestionnaire inscrit a terminé l’exécution, ni que les demandes d’annulation ont fini de se propager à tous les gestionnaires inscrits. Une synchronisation supplémentaire peut être nécessaire, en particulier dans les situations où des objets connexes sont annulés simultanément.

S’applique à

Voir aussi