CancellationToken.IsCancellationRequested Свойство

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

public bool IsCancellationRequested { get; }

member this.IsCancellationRequested : bool

Public ReadOnly Property IsCancellationRequested As Boolean

Значение свойства

true Значение , если отмена была запрошена для этого маркера; falseв противном случае .

Примеры

Ниже приведен простой пример, который выполняет процесс сервера, пока свойство не IsCancellationRequested возвращается 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.

В примере создается CancellationTokenSource экземпляр объекта, который управляет доступом к маркеру отмены. Затем он определяет две процедуры потока. Первое определяется как лямбда-выражение, которое пулует клавиатуру и при нажатии клавиши C вызовы CancellationTokenSource.Cancel для задания маркера отмены в отмененном состоянии. Второй — параметризованный метод, который выполняет цикл до тех пор, ServerClass.StaticMethodпока IsCancellationRequested свойство не будет true.

Затем основной поток запускает два потока и блоки, пока не завершится ServerClass.StaticMethod выполнение метода.

Комментарии

Это свойство указывает, запрашивается ли отмена для этого маркера либо с помощью маркера, изначально созданного в отмененном состоянии, либо путем вызова Cancel связанного CancellationTokenSourceмаркера.

Если это свойство имеет значение true, это гарантирует только запрос на отмену. Это не гарантирует, что все зарегистрированные обработчики завершили выполнение, а также что запросы на отмену завершили распространение для всех зарегистрированных обработчиков. Дополнительная синхронизация может потребоваться, особенно в ситуациях, когда связанные объекты отменяются одновременно.

См. также раздел

• Отмена
• отмена задачи