CancellationToken Struktura

Definicja

Przestrzeń nazw:

System.Threading

Zestaw:

System.Runtime.dll

Źródło:

CancellationToken.cs

Propaguje powiadomienie, że operacje powinny zostać anulowane.

public value class CancellationToken : IEquatable<System::Threading::CancellationToken>

public readonly struct CancellationToken : IEquatable<System.Threading.CancellationToken>

type CancellationToken = struct

Public Structure CancellationToken
Implements IEquatable(Of CancellationToken)

Dziedziczenie

Object

ValueType

CancellationToken

Implementuje

IEquatable<CancellationToken>

Przykłady

W poniższym przykładzie użyto generatora liczb losowych do emulacji aplikacji zbierania danych, która odczytuje 10 wartości całkowitych z jedenastu różnych instrumentów. Wartość zero wskazuje, że pomiar nie powiódł się dla jednego instrumentu, w takim przypadku operacja powinna zostać anulowana i nie należy obliczać ogólnej średniej.

Aby obsłużyć możliwe anulowanie operacji, przykład tworzy wystąpienie CancellationTokenSource obiektu, który generuje token anulowania przekazany do TaskFactory obiektu. Z kolei TaskFactory obiekt przekazuje token anulowania do każdego z zadań odpowiedzialnych za zbieranie odczytów dla określonego instrumentu. Metoda jest wywoływana TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken) w celu zapewnienia, że średnia jest obliczana dopiero po pomyślnym zebraniu wszystkich odczytów. Jeśli zadanie nie zostało ukończone, ponieważ zostało anulowane, TaskFactory.ContinueWhenAll metoda zgłasza wyjątek.

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      // Define the cancellation token.
      CancellationTokenSource source = new CancellationTokenSource();
      CancellationToken token = source.Token;

      Random rnd = new Random();
      Object lockObj = new Object();
      
      List<Task<int[]>> tasks = new List<Task<int[]>>();
      TaskFactory factory = new TaskFactory(token);
      for (int taskCtr = 0; taskCtr <= 10; taskCtr++) {
         int iteration = taskCtr + 1;
         tasks.Add(factory.StartNew( () => {
           int value;
           int[] values = new int[10];
           for (int ctr = 1; ctr <= 10; ctr++) {
              lock (lockObj) {
                 value = rnd.Next(0,101);
              }
              if (value == 0) { 
                 source.Cancel();
                 Console.WriteLine("Cancelling at task {0}", iteration);
                 break;
              }   
              values[ctr-1] = value; 
           }
           return values;
        }, token));   
      }
      try {
         Task<double> fTask = factory.ContinueWhenAll(tasks.ToArray(), 
         (results) => {
            Console.WriteLine("Calculating overall mean...");
            long sum = 0;
            int n = 0; 
            foreach (var t in results) {
               foreach (var r in t.Result) {
                  sum += r;
                  n++;
               }
            }
            return sum/(double) n;
         } , token);
         Console.WriteLine("The mean is {0}.", fTask.Result);
      }   
      catch (AggregateException ae) {
         foreach (Exception e in ae.InnerExceptions) {
            if (e is TaskCanceledException)
               Console.WriteLine("Unable to compute mean: {0}", 
                  ((TaskCanceledException) e).Message);
            else
               Console.WriteLine("Exception: " + e.GetType().Name);
         }
      }
      finally {
         source.Dispose();
      }
   }
}
// Repeated execution of the example produces output like the following:
//       Cancelling at task 5
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 10
//       Unable to compute mean: A task was canceled.
//       
//       Calculating overall mean...
//       The mean is 5.29545454545455.
//       
//       Cancelling at task 4
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 5
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 6
//       Unable to compute mean: A task was canceled.
//       
//       Calculating overall mean...
//       The mean is 4.97363636363636.
//       
//       Cancelling at task 4
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 5
//       Unable to compute mean: A task was canceled.
//       
//       Cancelling at task 4
//       Unable to compute mean: A task was canceled.
//       
//       Calculating overall mean...
//       The mean is 4.86545454545455.

Imports System.Collections.Generic
Imports System.Threading
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      ' Define the cancellation token.
      Dim source As New CancellationTokenSource()
      Dim token As CancellationToken = source.Token

      Dim lockObj As New Object()
      Dim rnd As New Random

      Dim tasks As New List(Of Task(Of Integer()))
      Dim factory As New TaskFactory(token)
      For taskCtr As Integer = 0 To 10
         Dim iteration As Integer = taskCtr + 1
         tasks.Add(factory.StartNew(Function()
                                       Dim value, values(9) As Integer
                                       For ctr As Integer = 1 To 10
                                          SyncLock lockObj
                                             value = rnd.Next(0,101)
                                          End SyncLock
                                          If value = 0 Then 
                                             source.Cancel
                                             Console.WriteLine("Cancelling at task {0}", iteration)
                                             Exit For
                                          End If   
                                          values(ctr-1) = value 
                                       Next
                                       Return values
                                    End Function, token))   
         
      Next
      Try
         Dim fTask As Task(Of Double) = factory.ContinueWhenAll(tasks.ToArray(), 
                                                         Function(results)
                                                            Console.WriteLine("Calculating overall mean...")
                                                            Dim sum As Long
                                                            Dim n As Integer 
                                                            For Each t In results
                                                               For Each r In t.Result
                                                                  sum += r
                                                                  n+= 1
                                                               Next
                                                            Next
                                                            Return sum/n
                                                         End Function, token)
         Console.WriteLine("The mean is {0}.", fTask.Result)
      Catch ae As AggregateException
         For Each e In ae.InnerExceptions
            If TypeOf e Is TaskCanceledException
               Console.WriteLine("Unable to compute mean: {0}", 
                                 CType(e, TaskCanceledException).Message)
            Else
               Console.WriteLine("Exception: " + e.GetType().Name)
            End If   
         Next
      Finally
         source.Dispose()
      End Try                                                          
   End Sub
End Module
' Repeated execution of the example produces output like the following:
'       Cancelling at task 5
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 10
'       Unable to compute mean: A task was canceled.
'       
'       Calculating overall mean...
'       The mean is 5.29545454545455.
'       
'       Cancelling at task 4
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 5
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 6
'       Unable to compute mean: A task was canceled.
'       
'       Calculating overall mean...
'       The mean is 4.97363636363636.
'       
'       Cancelling at task 4
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 5
'       Unable to compute mean: A task was canceled.
'       
'       Cancelling at task 4
'       Unable to compute mean: A task was canceled.
'       
'       Calculating overall mean...
'       The mean is 4.86545454545455.

Uwagi

Element CancellationToken umożliwia kooperatywne anulowanie między wątkami, elementami roboczymi puli wątków lub Task obiektami. Token anulowania jest tworzony przez utworzenie wystąpienia CancellationTokenSource obiektu, który zarządza tokenami anulowania pobranymi z jego CancellationTokenSource.Token właściwości. Następnie przekazujesz token anulowania do dowolnej liczby wątków, zadań lub operacji, które powinny otrzymać powiadomienie o anulowaniu. Nie można użyć tokenu do zainicjowania anulowania. Gdy obiekt jest właścicielem , CancellationTokenSource.CancelIsCancellationRequested właściwość na każdej kopii tokenu anulowania jest ustawiona na truewartość . Obiekty odbierające powiadomienie mogą odpowiadać w dowolny sposób.

Aby uzyskać więcej informacji i przykładów kodu, zobacz Anulowanie w zarządzanych wątkach.

Konstruktory

CancellationToken(Boolean)

Inicjuje element CancellationToken.

Właściwości

CanBeCanceled	Pobiera, czy ten token może być w stanie anulowania.
IsCancellationRequested	Pobiera, czy zażądano anulowania dla tego tokenu.
None	Zwraca pustą CancellationToken wartość.
WaitHandle	Pobiera sygnał WaitHandle , który jest sygnalizowany po anulowaniu tokenu.

Metody

Equals(CancellationToken)	Określa, czy bieżące CancellationToken wystąpienie jest równe określonemu tokenowi.
Equals(Object)	Określa, czy bieżące CancellationToken wystąpienie jest równe określonemu Object.
GetHashCode()	Służy jako funkcja skrótu dla elementu CancellationToken.
Register(Action)	Rejestruje delegata, który zostanie wywołany po CancellationToken anulowaniu.
Register(Action, Boolean)	Rejestruje delegata, który zostanie wywołany po CancellationToken anulowaniu.
Register(Action<Object,CancellationToken>, Object)	Rejestruje delegata, który zostanie wywołany po anulowaniu tego anulowania .
Register(Action<Object>, Object)	Rejestruje delegata, który zostanie wywołany po CancellationToken anulowaniu.
Register(Action<Object>, Object, Boolean)	Rejestruje delegata, który zostanie wywołany po CancellationToken anulowaniu.
ThrowIfCancellationRequested()	Zgłasza błąd, OperationCanceledException jeśli ten token zażądał anulowania.
UnsafeRegister(Action<Object,CancellationToken>, Object)	Rejestruje delegata, który zostanie wywołany po anulowaniu tego anulowania .
UnsafeRegister(Action<Object>, Object)	Rejestruje delegata, który jest wywoływany po CancellationToken anulowaniu.

Operatory

Equality(CancellationToken, CancellationToken)	Określa, czy dwa CancellationToken wystąpienia są równe.
Inequality(CancellationToken, CancellationToken)	Określa, czy dwa CancellationToken wystąpienia nie są równe.

Bezpieczeństwo wątkowe

Wszystkie publiczne i chronione elementy członkowskie są CancellationToken bezpieczne wątkowo i mogą być używane współbieżnie z wielu wątków.

Zobacz też

• Anulowanie
• Anulowanie zadania