CancellationToken.IsCancellationRequested Właściwość

Definicja

Pobiera, czy dla tego tokenu zażądano anulowania.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

Wartość właściwości

true, czy dla tego tokenu zażądano anulowania. w przeciwnym razie false.true if cancellation has been requested for this token; otherwise, false.

Przykłady

Poniżej znajduje się prosty przykład, który wykonuje proces serwera, dopóki właściwość IsCancellationRequested nie zwróci true.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.

Przykład tworzy wystąpienie obiektu CancellationTokenSource, który kontroluje dostęp do tokenu anulowania.The example instantiates a CancellationTokenSource object, which controls access to the cancellation token. Następnie definiuje dwa procedury wątków.It then defines two thread procedures. Pierwszy jest zdefiniowany jako wyrażenie lambda, które tworzy pulę klawiatury i, po naciśnięciu klawisza "C", wywołuje CancellationTokenSource.Cancel, aby ustawić token anulowania na stan anulowany.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. Druga jest metodą sparametryzowanej, ServerClass.StaticMethod, która wykonuje pętlę do momentu truewłaściwości IsCancellationRequested.The second is a parameterized method, ServerClass.StaticMethod, that executes a loop until the IsCancellationRequested property is true.

Następnie wątek główny uruchamia dwa wątki i bloki do momentu, gdy wątek, który wykonuje metodę ServerClass.StaticMethod zakończy działanie.The main thread then starts the two threads and blocks until the thread that executes the ServerClass.StaticMethod method terminates.

Uwagi

Ta właściwość wskazuje, czy dla tego tokenu zażądano anulowania, za pomocą tokenu początkowo w stanie anulowanym, czy przez wywołanie Cancel w skojarzonym CancellationTokenSourcetokenie.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.

Jeśli ta właściwość jest true, gwarantuje tylko, że żądanie zostało anulowane.If this property is true, it only guarantees that cancellation has been requested. Nie gwarantuje to, że każda zarejestrowana procedura obsługi zakończyła wykonywanie, ani czy żądania anulowania nie zakończyły propagowania do wszystkich zarejestrowanych programów obsługi.It does not guarantee that every registered handler has finished executing, nor that cancellation requests have finished propagating to all registered handlers. Może być wymagana dodatkowa synchronizacja, szczególnie w sytuacjach, w których obiekty pokrewne są anulowane współbieżnie.Additional synchronization may be required, particularly in situations where related objects are being canceled concurrently.

Dotyczy

Zobacz też