Udostępnij przez

CancellationTokenSource.Cancel Metoda

  • Odwołanie

Definicja

Przestrzeń nazw:
System.Threading
Zestaw:
System.Threading.Tasks.dll
Zestaw:
System.Runtime.dll
Zestaw:
mscorlib.dll
Zestaw:
netstandard.dll

Komunikuje żądanie anulowania.

Przeciążenia

Cancel()

Komunikuje żądanie anulowania.
Cancel(Boolean)

Komunikuje żądanie anulowania i określa, czy pozostałe wywołania zwrotne i operacje anulowania powinny być przetwarzane w przypadku wystąpienia wyjątku.

Cancel()

Komunikuje żądanie anulowania.

public:
 void Cancel();
public void Cancel ();
member this.Cancel : unit -> unit
Public Sub Cancel ()

Wyjątki

ObjectDisposedException

Zostało to CancellationTokenSource usunięte.

AggregateException

Wyjątek agregujący zawierający wszystkie wyjątki zgłoszone przez zarejestrowane wywołania zwrotne skojarzonego z usługą 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 przekazywany do TaskFactory obiektu. Obiekt TaskFactory z kolei 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 anulowane, wywołanie TaskFactory.ContinueWhenAll metody 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

Skojarzony CancellationToken element zostanie powiadomiony o anulowaniu i przejdzie do stanu, w którym IsCancellationRequested zwraca wartość true.

Wszystkie operacje wywołania zwrotnego lub anulowalne zarejestrowane w obiekcie CancellationToken zostaną wykonane.

Zalecamy anulowanie operacji i wywołań zwrotnych zarejestrowanych bez CancellationToken zgłaszania wyjątków.

To przeciążenie funkcji Anuluj spowoduje agregowanie wszystkich wyjątków zgłaszanych do AggregateExceptionobiektu , tak aby jeden wywołanie zwrotne zgłaszało wyjątek, nie uniemożliwi wykonania innych zarejestrowanych wywołań zwrotnych.

Wywołanie tej metody ma taki sam efekt jak wywoływanie metody Cancel(false).

Zobacz też

Dotyczy

Cancel(Boolean)

Komunikuje żądanie anulowania i określa, czy pozostałe wywołania zwrotne i operacje anulowania powinny być przetwarzane w przypadku wystąpienia wyjątku.

public:
 void Cancel(bool throwOnFirstException);
public void Cancel (bool throwOnFirstException);
member this.Cancel : bool -> unit
Public Sub Cancel (throwOnFirstException As Boolean)

Parametry

throwOnFirstException
Boolean

true jeśli wyjątki powinny być natychmiast propagowane; w przeciwnym razie , false.

Wyjątki

ObjectDisposedException

Zostało to CancellationTokenSource usunięte.

AggregateException

Wyjątek agregujący zawierający wszystkie wyjątki zgłoszone przez zarejestrowane wywołania zwrotne skojarzonego z usługą CancellationToken.

Uwagi

Skojarzony CancellationToken element zostanie powiadomiony o anulowaniu i przejdzie do stanu, w którym IsCancellationRequested zwraca wartość true.

Wszystkie operacje wywołania zwrotnego lub anulowalne zarejestrowane w obiekcie CancellationToken zostaną wykonane. Wywołania zwrotne będą wykonywane synchronicznie w kolejności LIFO.

Zalecamy anulowanie operacji i wywołań zwrotnych zarejestrowanych bez CancellationToken zgłaszania wyjątków.

Jeśli throwOnFirstException jest to true, wyjątek natychmiast rozpropaguje się z wywołania do Cancelmetody , uniemożliwiając przetworzenie pozostałych wywołań zwrotnych i anulowanych operacji.

Jeśli throwOnFirstException jest falseto , to przeciążenie będzie agregować wszelkie wyjątki zgłoszone do AggregateExceptionobiektu , tak aby jedno wywołanie zwrotne zgłaszające wyjątek nie uniemożliwiło wykonywania innych zarejestrowanych wywołań zwrotnych.

Zobacz też

Dotyczy