CancellationToken.IsCancellationRequested Propiedad

Definición

Espacio de nombres:

System.Threading

Ensamblado:

System.Runtime.dll

Source:

CancellationToken.cs

Obtiene si se ha solicitado la cancelación para este token.

public:
 property bool IsCancellationRequested { bool get(); };

public bool IsCancellationRequested { get; }

member this.IsCancellationRequested : bool

Public ReadOnly Property IsCancellationRequested As Boolean

Valor de propiedad

Boolean

true si se solicitó la cancelación de este token; en caso contrario, false.

Ejemplos

A continuación se muestra un ejemplo sencillo que ejecuta un proceso de servidor hasta que la IsCancellationRequested propiedad devuelve 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.

En el ejemplo se crea una instancia de un CancellationTokenSource objeto , que controla el acceso al token de cancelación. A continuación, define dos procedimientos de subproceso. La primera se define como una expresión lambda que agrupa el teclado y, cuando se presiona la tecla "C", llama CancellationTokenSource.Cancel a para establecer el token de cancelación en el estado cancelado. El segundo es un método con parámetros, ServerClass.StaticMethod, que ejecuta un bucle hasta que la IsCancellationRequested propiedad es true.

A continuación, el subproceso principal inicia los dos subprocesos y se bloquea hasta que finaliza el subproceso que ejecuta el ServerClass.StaticMethod método.

Comentarios

Esta propiedad indica si se ha solicitado la cancelación para este token, ya sea a través del token que se construye inicialmente en un estado cancelado o mediante una llamada Cancel a en el token asociado CancellationTokenSource.

Si esta propiedad es true, solo garantiza que se haya solicitado la cancelación. No garantiza que todos los controladores registrados hayan terminado de ejecutarse, ni que las solicitudes de cancelación hayan terminado de propagarse a todos los controladores registrados. Es posible que sea necesaria una sincronización adicional, especialmente en situaciones en las que los objetos relacionados se cancelan simultáneamente.

Consulte también

• Cancelación
• Cancelación de tareas