CancellationToken.IsCancellationRequested Eigenschap

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

public bool IsCancellationRequested { get; }

member this.IsCancellationRequested : bool

Public ReadOnly Property IsCancellationRequested As Boolean

Waarde van eigenschap

true indien annulering is aangevraagd voor dit token; anders, false.

Voorbeelden

Hier volgt een eenvoudig voorbeeld waarmee een serverproces wordt uitgevoerd totdat de IsCancellationRequested eigenschap wordt geretourneerd 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.

In het voorbeeld wordt een CancellationTokenSource object geïnstitueert, waarmee de toegang tot het annuleringstoken wordt gecontroleerd. Vervolgens worden twee threadprocedures gedefinieerd. De eerste wordt gedefinieerd als een lambda-expressie waarmee het toetsenbord wordt gegroepeerd en, wanneer de toets C wordt ingedrukt, wordt aanroepen CancellationTokenSource.Cancel om het annuleringstoken in te stellen op de geannuleerde status. De tweede is een geparameteriseerde methode, ServerClass.StaticMethoddie een lus uitvoert totdat de IsCancellationRequested eigenschap is true.

De hoofdthread start vervolgens de twee threads en blokken totdat de thread die de ServerClass.StaticMethod methode uitvoert, wordt beëindigd.

Opmerkingen

Deze eigenschap geeft aan of annulering is aangevraagd voor dit token, ofwel via het token dat in eerste instantie wordt samengesteld in een geannuleerde status, of door het aanroepen van Cancel de gekoppelde CancellationTokenSourcetoken.

Als deze accommodatie is true, garandeert het alleen dat annulering is aangevraagd. Het garandeert niet dat elke geregistreerde handler klaar is met uitvoeren, noch dat annuleringsaanvragen zijn doorgegeven aan alle geregistreerde handlers. Er kan extra synchronisatie vereist zijn, met name in situaties waarin gerelateerde objecten gelijktijdig worden geannuleerd.

Zie ook

• annulerings-
• Taakannulering