CancellationToken.IsCancellationRequested Właściwość

Definicja

Przestrzeń nazw:

System.Threading

Zestaw:

System.Threading.Tasks.dll

Zestaw:

System.Runtime.dll

Zestaw:

mscorlib.dll

Zestaw:

netstandard.dll

Pobiera informację o żądaniu anulowania dla tego tokenu.

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

Boolean

true jeśli zażądano anulowania dla tego tokenu; w przeciwnym razie , false.

Przykłady

Poniżej przedstawiono prosty przykład, który wykonuje proces serwera do momentu, gdy IsCancellationRequested właściwość zwróci wartość 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 CancellationTokenSource obiektu, który kontroluje dostęp do tokenu anulowania. Następnie definiuje dwie procedury wątku. Pierwszy jest zdefiniowany jako wyrażenie lambda, które pule klawiatury, a po naciśnięciu klawisza "C" wywołania CancellationTokenSource.Cancel w celu ustawienia tokenu anulowania na stan anulowany. Drugi to sparametryzowana metoda , ServerClass.StaticMethodktóra wykonuje pętlę do momentu, gdy IsCancellationRequested właściwość ma truewartość .

Główny wątek uruchamia następnie dwa wątki i bloki do momentu zakończenia wątku wykonującego metodę ServerClass.StaticMethod .

Uwagi

Ta właściwość wskazuje, czy zażądano anulowania dla tego tokenu, za pośrednictwem tokenu, który początkowo jest konstruowany w stanie anulowanym, czy przez wywołanie Cancel skojarzonego CancellationTokenSourcetokenu .

Jeśli ta właściwość ma truewartość , gwarantuje tylko, że zażądano anulowania. Nie gwarantuje to, że każda zarejestrowana procedura obsługi zakończyła wykonywanie, ani że żądania anulowania zakończyły propagację do wszystkich zarejestrowanych procedur obsługi. Może być wymagana dodatkowa synchronizacja, szczególnie w sytuacjach, w których powiązane obiekty są anulowane współbieżnie.

Zobacz też

• Anulowanie
• Anulowanie zadania