CancellationToken.IsCancellationRequested Свойство

Определение

Возвращает значение, указывающее, есть ли для данного токена запрос на отмену.

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

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

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 завершит работу.

Комментарии

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

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

Применяется к

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