CancellationToken.IsCancellationRequested Vlastnost

Definice

Vrátí, zda byl pro tento token požadován zrušení.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

Hodnota vlastnosti

true, zda byl pro tento token požadován zrušení; v opačném případě false.true if cancellation has been requested for this token; otherwise, false.

Příklady

Následuje jednoduchý příklad, který spustí proces serveru, dokud vlastnost IsCancellationRequested nevrátí 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.

Příklad vytvoří instanci objektu CancellationTokenSource, který řídí přístup k tokenu zrušení.The example instantiates a CancellationTokenSource object, which controls access to the cancellation token. Pak definuje dva procedury vlákna.It then defines two thread procedures. První je definován jako výraz lambda, který vytváří fondy klávesnice a při stisknutí klávesy "C" volá CancellationTokenSource.Cancel k nastavení tokenu zrušení na zrušený stav.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. Druhým je parametrizovaná metoda, ServerClass.StaticMethod, která spustí smyčku, dokud není truevlastnost IsCancellationRequested.The second is a parameterized method, ServerClass.StaticMethod, that executes a loop until the IsCancellationRequested property is true.

Hlavní vlákno potom spustí dvě vlákna a zablokuje, dokud vlákno, které provádí metodu ServerClass.StaticMethod, ukončeno.The main thread then starts the two threads and blocks until the thread that executes the ServerClass.StaticMethod method terminates.

Poznámky

Tato vlastnost označuje, zda bylo pro tento token vyžádáno zrušení, buď prostřednictvím tokenu, zpočátku vytvořeného ve zrušeném stavu, nebo voláním Cancel v přidružené CancellationTokenSourcetokenu.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.

Pokud je tato vlastnost true, zaručuje pouze to, že bylo zrušení požadováno.If this property is true, it only guarantees that cancellation has been requested. Nezaručuje, že všechny zaregistrované obslužné rutiny se dokončily, ani že žádosti o zrušení dokončí rozšiřování všech registrovaných obslužných rutin.It does not guarantee that every registered handler has finished executing, nor that cancellation requests have finished propagating to all registered handlers. Může se vyžadovat další synchronizace, zejména v situacích, kdy se související objekty ruší současně.Additional synchronization may be required, particularly in situations where related objects are being canceled concurrently.

Platí pro

Viz také