CancellationToken.IsCancellationRequested Vlastnost

Definice

Obor názvů:

System.Threading

Sestavení:

System.Runtime.dll

Zdroj:

CancellationToken.cs

Získá, zda bylo požadováno zrušení pro tento token.

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

public bool IsCancellationRequested { get; }

member this.IsCancellationRequested : bool

Public ReadOnly Property IsCancellationRequested As Boolean

Hodnota vlastnosti

Boolean

truePokud bylo pro tento token požadováno zrušení; v opačném případě . false

Příklady

Následuje jednoduchý příklad, který spouští serverový proces, dokud IsCancellationRequested vlastnost nevrátí 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í. Pak definuje dvě procedury vlákna. První je definován jako výraz lambda, který sdružuje klávesnici, a když je stisknutá klávesa "C", volá volání CancellationTokenSource.Cancel pro nastavení tokenu zrušení do stavu zrušeno. Druhá je parametrizovaná metoda , ServerClass.StaticMethodkterá provádí smyčku, dokud IsCancellationRequested vlastnost nebude true.

Hlavní vlákno pak spustí dvě vlákna a blokuje, dokud vlákno, které spouští metodu ServerClass.StaticMethod , ukončí.

Poznámky

Tato vlastnost označuje, zda bylo pro tento token požadováno zrušení, a to buď prostřednictvím tokenu, který byl původně vytvořen v zrušeném stavu, nebo voláním Cancel na token přidružené CancellationTokenSource.

Pokud je truetato vlastnost , zaručuje pouze žádost o zrušení. Nezaručuje, že každá registrovaná obslužná rutina dokončila provádění, ani že se požadavky na zrušení dokončily šíření do všech registrovaných obslužných rutin. Může být vyžadována další synchronizace, zejména v situacích, kdy jsou související objekty zrušeny souběžně.

Viz také

• Zrušení
• Zrušení úlohy