CancellationTokenSource.Cancel Метод

Определение

Передает запрос на отмену.Communicates a request for cancellation.

Перегрузки

Cancel()

Передает запрос на отмену.Communicates a request for cancellation.

Cancel(Boolean)

Передает запрос отмены и определяет, будут ли последующие обратные вызовы и отменяемые операции обрабатываться при возникновении исключения.Communicates a request for cancellation, and specifies whether remaining callbacks and cancelable operations should be processed if an exception occurs.

Cancel()

Передает запрос на отмену.Communicates a request for cancellation.

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

Исключения

Данный объект CancellationTokenSource был удален.This CancellationTokenSource has been disposed.

Статистическое исключение, содержащее все исключения, созданные зарегистрированными обратными вызовами на связанном CancellationToken.An aggregate exception containing all the exceptions thrown by the registered callbacks on the associated CancellationToken.

Примеры

В следующем примере генератор случайных чисел используется для эмуляции приложения сбора данных, которое считывает 10 целочисленных значений из одиннадцати различных инструментов.The following example uses a random number generator to emulate a data collection application that reads 10 integral values from eleven different instruments. Нулевое значение указывает на то, что измерение завершилось ошибкой для одного инструмента. в этом случае операция должна быть отменена, а общее среднее значение не должно вычисляться.A value of zero indicates that the measurement has failed for one instrument, in which case the operation should be cancelled and no overall mean should be computed.

Чтобы справиться с возможной отменой операции, в примере создается экземпляр CancellationTokenSource объекта, который создает токен отмены, который передается в TaskFactory объект.To handle the possible cancellation of the operation, the example instantiates a CancellationTokenSource object that generates a cancellation token which is passed to a TaskFactory object. TaskFactoryОбъект, в свою очередь, передает токен отмены каждой из задач, ответственных за сбор данных для конкретного инструмента.The TaskFactory object in turn passes the cancellation token to each of the tasks responsible for collecting readings for a particular instrument. TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken)Метод вызывается, чтобы гарантировать, что среднее вычисляется только после успешного сбора всех считываний.The TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken) method is called to ensure that the mean is computed only after all readings have been gathered successfully. Если задача не выполнена, поскольку она была отменена, вызов TaskFactory.ContinueWhenAll метода вызывает исключение.If a task has not because it has been cancelled, the call to the TaskFactory.ContinueWhenAll method throws an exception.

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.

Комментарии

Связанный объект CancellationToken будет уведомлен об отмене и будет переходить в состояние, где IsCancellationRequested возвращает значение true.The associated CancellationToken will be notified of the cancellation and will transition to a state where IsCancellationRequested returns true.

Будут выполнены любые обратные вызовы или операции, которые можно отменять, зарегистрированные в CancellationToken .Any callbacks or cancelable operations registered with the CancellationToken will be executed.

Рекомендуется, чтобы отменяемые операции и обратные вызовы, зарегистрированные, CancellationToken не вызывали исключения.We recommend that cancelable operations and callbacks registered with CancellationToken not throw exceptions.

Эта перегрузка отмены выполнит статистическую обработку всех исключений, порожденных в AggregateException , так что один обратный вызов, создающий исключение, не будет препятствовать выполнению других зарегистрированных обратных вызовов.This overload of Cancel will aggregate any exceptions thrown into an AggregateException, such that one callback throwing an exception will not prevent other registered callbacks from being executed.

См. также раздел

Применяется к

Cancel(Boolean)

Передает запрос отмены и определяет, будут ли последующие обратные вызовы и отменяемые операции обрабатываться при возникновении исключения.Communicates a request for cancellation, and specifies whether remaining callbacks and cancelable operations should be processed if an exception occurs.

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

Параметры

throwOnFirstException
Boolean

true, если исключения нужно распространять немедленно; в противном случае — значение false.true if exceptions should immediately propagate; otherwise, false.

Исключения

Данный объект CancellationTokenSource был удален.This CancellationTokenSource has been disposed.

Статистическое исключение, содержащее все исключения, созданные зарегистрированными обратными вызовами на связанном CancellationToken.An aggregate exception containing all the exceptions thrown by the registered callbacks on the associated CancellationToken.

Комментарии

Связанный объект CancellationToken будет уведомлен об отмене и перейдет в состояние, в котором IsCancellationRequested возвращается значение true .The associated CancellationToken will be notified of the cancellation and will transition to a state where IsCancellationRequested returns true.

Будут выполнены любые обратные вызовы или операции, которые можно отменять, зарегистрированные в CancellationToken .Any callbacks or cancelable operations registered with the CancellationToken will be executed. Обратные вызовы будут выполняться синхронно в порядке ЛИФО.Callbacks will be executed synchronously in LIFO order.

Рекомендуется, чтобы отменяемые операции и обратные вызовы, зарегистрированные, CancellationToken не вызывали исключения.We recommend that cancelable operations and callbacks registered with CancellationToken not throw exceptions.

Если throwOnFirstException имеет значение true , то исключение немедленно распространяет из вызова Cancel , предотвращая обработку оставшихся обратных вызовов и отменяемых операций.If throwOnFirstException is true, an exception will immediately propagate out of the call to Cancel, preventing the remaining callbacks and cancelable operations from being processed.

Если throwOnFirstException имеет значение false , эта перегрузка выполнит статистическую обработку всех исключений, порожденных в AggregateException , чтобы один обратный вызов, создающий исключение, не препятствовал выполнению других зарегистрированных обратных вызовов.If throwOnFirstException is false, this overload will aggregate any exceptions thrown into an AggregateException, such that one callback throwing an exception will not prevent other registered callbacks from being executed.

См. также раздел

Применяется к