CancellationToken.IsCancellationRequested Eigenschaft

Definition

Namespace:

System.Threading

Assembly:

System.Runtime.dll

Quelle:

CancellationToken.cs

Ruft einen Wert ab, der angibt, ob für dieses Token ein Abbruch angefordert wurde.

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

public bool IsCancellationRequested { get; }

member this.IsCancellationRequested : bool

Public ReadOnly Property IsCancellationRequested As Boolean

Eigenschaftswert

Boolean

true, wenn der Abbruch für dieses Token angefordert wurde, andernfalls false.

Beispiele

Im Folgenden finden Sie ein einfaches Beispiel, das einen Serverprozess ausführt, bis die IsCancellationRequested -Eigenschaft zurückgibt 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. Die erste wird als Lambdaausdruck definiert, der die Tastatur bündelt und, wenn die Taste "C" gedrückt wird, aufruft CancellationTokenSource.Cancel , um das Abbruchtoken auf den abgebrochenen Zustand festzulegen. Die zweite ist eine parametrisierte Methode, , die eine Schleife ausführt, ServerClass.StaticMethodbis die IsCancellationRequested -Eigenschaft ist true.

Der Hauptthread startet dann die beiden Threads und Blöcke, 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 durch das Token, das ursprünglich in einem abgebrochenen Zustand erstellt wurde, oder durch Aufrufen Cancel des dem Token zugeordneten CancellationTokenSource.

Wenn diese Eigenschaft ist true, wird nur sichergestellt, dass der Abbruch angefordert wurde. Es garantiert nicht, dass jeder registrierte Handler die Ausführung beendet hat, noch, dass abbruchanforderungen an alle registrierten Handler weitergegeben wurden. Eine zusätzliche Synchronisierung kann erforderlich sein, insbesondere in Situationen, in denen verwandte Objekte gleichzeitig abgebrochen werden.

Weitere Informationen

• Abbruch
• Aufgabenabbruch