CancellationToken.IsCancellationRequested Propriedade

  • Referência

Definição

Namespace:
System.Threading
Assembly:
System.Threading.Tasks.dll
Assembly:
System.Runtime.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll

Especifica se o cancelamento foi solicitado para esse token.

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

Valor da propriedade

Boolean

true se o cancelamento tiver sido solicitado para esse token; caso contrário, false.

Exemplos

Veja a seguir um exemplo simples que executa um processo de servidor até que a IsCancellationRequested propriedade retorne 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.

O exemplo cria uma instância de um CancellationTokenSource objeto, que controla o acesso ao token de cancelamento. Em seguida, ele define dois procedimentos de thread. A primeira é definida como uma expressão lambda que agrupa o teclado e, quando a tecla "C" é pressionada, chama CancellationTokenSource.Cancel para definir o token de cancelamento para o estado cancelado. O segundo é um método parametrizado, ServerClass.StaticMethodque executa um loop até que a IsCancellationRequested propriedade seja true.

Em seguida, o thread principal inicia os dois threads e bloqueia até que o thread que executa o ServerClass.StaticMethod método seja encerrado.

Comentários

Essa propriedade indica se o cancelamento foi solicitado para esse token, seja por meio do token que está sendo construído inicialmente em um estado cancelado ou por meio da chamada Cancel ao token associado CancellationTokenSource.

Se essa propriedade for true, ela garante apenas que o cancelamento tenha sido solicitado. Ele não garante que todos os manipuladores registrados tenham terminado de executar, nem que as solicitações de cancelamento tenham terminado de se propagar para todos os manipuladores registrados. A sincronização adicional pode ser necessária, especialmente em situações em que objetos relacionados estão sendo cancelados simultaneamente.

Aplica-se a

Confira também