CancellationTokenSource.Cancel Metoda

Definice

Oznamuje požadavek na zrušení.Communicates a request for cancellation.

Přetížení

Cancel()

Oznamuje požadavek na zrušení.Communicates a request for cancellation.

Cancel(Boolean)

Oznamuje požadavek na zrušení a určuje, zda by se měly zpracovat zbývající zpětná volání a operace zrušení, pokud dojde k výjimce.Communicates a request for cancellation, and specifies whether remaining callbacks and cancelable operations should be processed if an exception occurs.

Cancel()

Oznamuje požadavek na zrušení.Communicates a request for cancellation.

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

Výjimky

Agregovaná výjimka obsahující všechny výjimky vyvolané registrovanými zpětnými voláními na přidružených CancellationToken .An aggregate exception containing all the exceptions thrown by the registered callbacks on the associated CancellationToken.

Příklady

Následující příklad používá generátor náhodných čísel k emulaci aplikace shromažďování dat, která čte 10 integrálních hodnot z jedenáct různých nástrojů.The following example uses a random number generator to emulate a data collection application that reads 10 integral values from eleven different instruments. Hodnota nula znamená, že měření se pro jeden nástroj nezdařilo. v takovém případě by operace měla být zrušena a žádný celkový význam by neměl být vypočítán.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.

Aby bylo možné zpracovat možnou zrušení operace, příklad vytvoří instanci CancellationTokenSource objektu, který generuje token zrušení, který je předán TaskFactory objektu.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. TaskFactoryObjekt zase předá token zrušení každému z úloh zodpovědných za shromažďování čtení pro konkrétní instrumentaci.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)Metoda je volána, aby se zajistilo, že se střední hodnota vypočítá až po úspěšném shromáždění všech čtení.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. Pokud úloha není, protože byla zrušena, volání TaskFactory.ContinueWhenAll metody vyvolá výjimku.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.

Poznámky

Přidružená zpráva CancellationToken bude upozorněna na zrušení a přejde do stavu, kde IsCancellationRequested vrátí hodnotu true.The associated CancellationToken will be notified of the cancellation and will transition to a state where IsCancellationRequested returns true.

Budou provedena všechna zpětná volání a operace, které lze zrušit v registraci CancellationToken .Any callbacks or cancelable operations registered with the CancellationToken will be executed.

Doporučujeme, abyste zrušili operace a zpětná volání, která jsou zaregistrovaná bez CancellationToken vyvolání výjimek.We recommend that cancelable operations and callbacks registered with CancellationToken not throw exceptions.

Toto přetížení metody Cancel agreguje všechny výjimky vyvolané do AggregateException , což způsobí, že jedno zpětné volání, které vyvolá výjimku, nebrání v provádění jiných registrovaných zpětných volání.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.

Platí pro

Cancel(Boolean)

Oznamuje požadavek na zrušení a určuje, zda by se měly zpracovat zbývající zpětná volání a operace zrušení, pokud dojde k výjimce.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)

Parametry

throwOnFirstException
Boolean

true Pokud by výjimky měly ihned šířit; v opačném případě false .true if exceptions should immediately propagate; otherwise, false.

Výjimky

Agregovaná výjimka obsahující všechny výjimky vyvolané registrovanými zpětnými voláními na přidružených CancellationToken .An aggregate exception containing all the exceptions thrown by the registered callbacks on the associated CancellationToken.

Poznámky

Přidružená zpráva CancellationToken bude upozorněna na zrušení a přechod na stav, kde se IsCancellationRequested vrátí true .The associated CancellationToken will be notified of the cancellation and will transition to a state where IsCancellationRequested returns true.

Budou provedena všechna zpětná volání a operace, které lze zrušit v registraci CancellationToken .Any callbacks or cancelable operations registered with the CancellationToken will be executed. Zpětná volání budou provedena synchronně v pořadí LIFO.Callbacks will be executed synchronously in LIFO order.

Doporučujeme, abyste zrušili operace a zpětná volání, která jsou zaregistrovaná bez CancellationToken vyvolání výjimek.We recommend that cancelable operations and callbacks registered with CancellationToken not throw exceptions.

V throwOnFirstException případě true , výjimka okamžitě rozšíří volání do, aby se Cancel zabránilo zbývajícím zpětným voláním a zrušením operací, které se mají zpracovat.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.

Pokud throwOnFirstException je false , toto přetížení agreguje všechny výjimky vyvolané do, což znamená AggregateException , že jedno zpětné volání, které vyvolává výjimku, nebrání v provádění jiných registrovaných zpětných volání.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.

Platí pro