CancellationToken.IsCancellationRequested Eigenschaft

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

public bool IsCancellationRequested { get; }

member this.IsCancellationRequested : bool

Public ReadOnly Property IsCancellationRequested As Boolean

Eigenschaftswert

truewenn der Abbruch für dieses Token angefordert wurde; andernfalls . false

Beispiele

Im Folgenden sehen Sie ein einfaches Beispiel, das einen Serverprozess ausführt, bis die IsCancellationRequested Eigenschaft zurückgegeben wird 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.

Im Beispiel wird ein CancellationTokenSource Objekt instanziiert, das den Zugriff auf das Abbruchtoken steuert. Anschließend werden zwei Threadprozeduren definiert. Der erste wird als Lambda-Ausdruck definiert, der die Tastatur einpoolt und beim Drücken der Taste "C" aufruft CancellationTokenSource.Cancel , um das Abbruchtoken auf den abgebrochenen Zustand festzulegen. Die zweite ist eine parametrisierte Methode, ServerClass.StaticMethoddie eine Schleife ausführt, bis die IsCancellationRequested Eigenschaft ist true.

Der Hauptthread startet dann die beiden Threads und blockiert, bis der Thread, der die ServerClass.StaticMethod Methode ausführt, beendet wird.

Hinweise

Diese Eigenschaft gibt an, ob der Abbruch für dieses Token angefordert wurde, entweder über das Token, das zunächst in einem abgebrochenen Zustand erstellt wird, oder über den Aufruf Cancel des zugeordneten CancellationTokenSourceTokens.

Wenn diese Eigenschaft lautet true, garantiert sie nur, dass eine Stornierung angefordert wurde. Es garantiert nicht, dass jeder registrierte Handler die Ausführung abgeschlossen hat, oder dass Abbruchanforderungen die Weitergabe an alle registrierten Handler abgeschlossen haben. Es kann eine zusätzliche Synchronisierung erforderlich sein, insbesondere in Situationen, in denen verwandte Objekte gleichzeitig abgebrochen werden.

Weitere Informationen

• Stornierung
• Vorgangsabbruch