CancellationToken.IsCancellationRequested CancellationToken.IsCancellationRequested CancellationToken.IsCancellationRequested CancellationToken.IsCancellationRequested Property

Definition

Ruft einen Wert ab, der angibt, ob für dieses Token ein Abbruch angefordert wurde.Gets whether cancellation has been requested for this token.

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

Eigenschaftswert

true, wenn der Abbruch für dieses Token angefordert wurde, andernfalls false.true if cancellation has been requested for this token; otherwise, false.

Beispiele

Im folgenden finden Sie ein einfaches Beispiel, in dem ein Server Prozess ausgeführt wird, bis die IsCancellationRequested-Eigenschaft true zurückgibt.The following is a simple example that executes a server process until the IsCancellationRequested property returns 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 Abbruch Token steuert.The example instantiates a CancellationTokenSource object, which controls access to the cancellation token. Anschließend werden zwei Thread Prozeduren definiert.It then defines two thread procedures. Der erste ist als ein Lambda-Ausdruck definiert, der die Tastatur poolt und beim Drücken der Taste "C" CancellationTokenSource.Cancel aufruft, um das Abbruch Token auf den Zustand "abgebrochen" festzulegen.The first is defined as a lambda expression that pools the keyboard and, when the "C" key is pressed, calls CancellationTokenSource.Cancel to set the cancellation token to the cancelled state. Die zweite ist eine parametrisierte Methode (ServerClass.StaticMethod), die eine Schleife ausführt, bis die Eigenschaft IsCancellationRequested true ist.The second is a parameterized method, ServerClass.StaticMethod, that executes a loop until the IsCancellationRequested property is true.

Der Haupt Thread startet dann die beiden Threads und wird blockiert, bis der Thread, der die ServerClass.StaticMethod-Methode ausführt, beendet wird.The main thread then starts the two threads and blocks until the thread that executes the ServerClass.StaticMethod method terminates.

Hinweise

Diese Eigenschaft gibt an, ob für dieses Token ein Abbruch angefordert wurde, entweder über das Token, das anfänglich in einem abgebrochenen Zustand erstellt wurde, oder durch Aufrufen von Cancel für die zugeordnete CancellationTokenSource des Tokens.This property indicates whether cancellation has been requested for this token, either through the token initially being constructed in a canceled state, or through calling Cancel on the token's associated CancellationTokenSource.

Wenn diese Eigenschaft true ist, wird nur sichergestellt, dass ein Abbruch angefordert wurde.If this property is true, it only guarantees that cancellation has been requested. Es garantiert nicht, dass jeder registrierte Handler die Ausführung abgeschlossen hat, und dass Abbruch Anforderungen die Weitergabe an alle registrierten Handler beendet haben.It does not guarantee that every registered handler has finished executing, nor that cancellation requests have finished propagating to all registered handlers. Möglicherweise ist eine zusätzliche Synchronisierung erforderlich, insbesondere in Situationen, in denen verbundene Objekte gleichzeitig abgebrochen werden.Additional synchronization may be required, particularly in situations where related objects are being canceled concurrently.

Gilt für:

Siehe auch