CancellationToken.IsCancellationRequested Özellik

Tanım

Ad Alanı:

System.Threading

Bütünleştirilmiş Kod:

System.Threading.Tasks.dll

Bütünleştirilmiş Kod:

System.Runtime.dll

Bütünleştirilmiş Kod:

mscorlib.dll

Bütünleştirilmiş Kod:

netstandard.dll

Bu belirteç için iptal istenip istenmediğini alır.

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

public bool IsCancellationRequested { get; }

member this.IsCancellationRequested : bool

Public ReadOnly Property IsCancellationRequested As Boolean

Özellik Değeri

Boolean

true bu belirteç için iptal istendiyse; aksi takdirde , false.

Örnekler

Aşağıda, özelliği döndürene kadar IsCancellationRequested bir sunucu işlemi yürüten basit bir örnek verilmiştir 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.

Örnek, iptal belirtecine erişimi denetleyen bir CancellationTokenSource nesnesinin örneğini oluşturur. Ardından iki iş parçacığı yordamı tanımlar. birincisi, klavyeyi havuza alan bir lambda ifadesi olarak tanımlanır ve "C" tuşuna basıldığında iptal belirtecini iptal edilmiş duruma ayarlamak için çağrılar CancellationTokenSource.Cancel yapılır. İkincisi, ServerClass.StaticMethodözelliği olana kadar IsCancellationRequested bir döngü yürüten parametreli yöntemidir true.

Ana iş parçacığı daha sonra iki iş parçacığını başlatır ve yöntemi yürüten ServerClass.StaticMethod iş parçacığı sonlandırana kadar engeller.

Açıklamalar

Bu özellik, başlangıçta iptal edilmiş durumda oluşturulmakta olan belirteç veya belirtecin ilişkili CancellationTokenSourceüzerinde çağrısı Cancel yoluyla bu belirteç için iptalin istenip istenmediğini gösterir.

Bu özellik ise true, yalnızca iptalin istendiğini garanti eder. Her kayıtlı işleyicinin yürütülmesinin tamamlandığını veya iptal isteklerinin tüm kayıtlı işleyicilere yayılmasının tamamlandığını garanti etmez. Özellikle ilgili nesnelerin eşzamanlı olarak iptal edildiği durumlarda ek eşitleme gerekebilir.

Ayrıca bkz.

• İptal
• Görev iptali