CancellationToken.IsCancellationRequested Tulajdonság

Definíció

Névtér:

System.Threading

Szerelvények:

netstandard.dll, System.Runtime.dll

Forrás:

CancellationToken.cs

Lekérdezi, hogy a jogkivonat törlését kérték-e.

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

public bool IsCancellationRequested { get; }

member this.IsCancellationRequested : bool

Public ReadOnly Property IsCancellationRequested As Boolean

Tulajdonság értéke

Boolean

trueha a jogkivonat törlését kérték; egyéb esetben. false

Példák

Az alábbiakban egy egyszerű példa látható, amely egy kiszolgálói folyamatot hajt végre, amíg a IsCancellationRequested tulajdonság vissza nem tér 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.

A példa létrehoz egy CancellationTokenSource objektumot, amely szabályozza a lemondási jogkivonathoz való hozzáférést. Ezután két szál eljárást határoz meg. Az első lambda kifejezésként van definiálva, amely a billentyűzetet készletezi, és a "C" billentyű lenyomásakor meghívja CancellationTokenSource.Cancel a lemondási jogkivonatot a törölt állapotra. A második egy paraméteres metódus, amely addig hajt végre egy hurkot, ServerClass.StaticMethodamíg a IsCancellationRequested tulajdonság nem lesz true.

A főszál ezután elindítja a két szálat, és addig blokkolja, amíg a metódust ServerClass.StaticMethod végrehajtó szál le nem áll.

Megjegyzések

Ez a tulajdonság azt jelzi, hogy a jogkivonat törlését kérték-e, akár az eredetileg törölt állapotban létrehozott jogkivonaton keresztül, akár a jogkivonat társított Canceljogkivonatának meghívásávalCancellationTokenSource.

Ha ez a tulajdonság, truecsak azt garantálja, hogy a törlést kérték. Nem garantálja, hogy minden regisztrált kezelő befejezte a végrehajtást, és azt sem, hogy a törlési kérelmek propagálása befejeződött az összes regisztrált kezelő számára. További szinkronizálásra lehet szükség, különösen olyan esetekben, amikor a kapcsolódó objektumok egyidejűleg megszakadnak.

Lásd még

• lemondás
• tevékenység lemondási