CancellationTokenSource Třída

Definice

Signalizuje CancellationToken , že by měla být zrušena.Signals to a CancellationToken that it should be canceled.

public ref class CancellationTokenSource : IDisposable
public ref class CancellationTokenSource sealed : IDisposable
public class CancellationTokenSource : IDisposable
[System.Runtime.InteropServices.ComVisible(false)]
public sealed class CancellationTokenSource : IDisposable
[System.Runtime.InteropServices.ComVisible(false)]
public class CancellationTokenSource : IDisposable
type CancellationTokenSource = class
    interface IDisposable
[<System.Runtime.InteropServices.ComVisible(false)>]
type CancellationTokenSource = class
    interface IDisposable
Public Class CancellationTokenSource
Implements IDisposable
Public NotInheritable Class CancellationTokenSource
Implements IDisposable
Dědičnost
CancellationTokenSource
Atributy
Implementuje

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

Počínaje .NET Framework 4 používá .NET Framework jednotný model pro spolupráci se zrušením asynchronních nebo dlouhotrvajících synchronních operací, které zahrnují dva objekty:Starting with the .NET Framework 4, the .NET Framework uses a unified model for cooperative cancellation of asynchronous or long-running synchronous operations that involves two objects:

Obecný vzor pro implementaci modelu zrušení spolupráce je:The general pattern for implementing the cooperative cancellation model is:

Další informace naleznete v tématu zrušení ve spravovaných vláknech.For more information, see Cancellation in Managed Threads.

Důležité

Tento typ implementuje IDisposable rozhraní.This type implements the IDisposable interface. Po dokončení použití instance typu byste ji měli nakládat přímo nebo nepřímo.When you have finished using an instance of the type, you should dispose of it either directly or indirectly. Chcete-li přímo uvolnit typ, zavolejte jeho Dispose metodu v try / catch bloku.To dispose of the type directly, call its Dispose method in a try/catch block. Chcete-li ji nakládat nepřímo, použijte konstrukci jazyka, například using (v jazyce C#) nebo Using (v Visual Basic).To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). Další informace naleznete v části "použití objektu, který implementuje IDisposable" v IDisposable tématu rozhraní.For more information, see the "Using an Object that Implements IDisposable" section in the IDisposable interface topic.

Konstruktory

CancellationTokenSource()

Inicializuje novou instanci CancellationTokenSource třídy.Initializes a new instance of the CancellationTokenSource class.

CancellationTokenSource(Int32)

Inicializuje novou instanci CancellationTokenSource třídy, která bude zrušena po zadané prodlevě v milisekundách.Initializes a new instance of the CancellationTokenSource class that will be canceled after the specified delay in milliseconds.

CancellationTokenSource(TimeSpan)

Inicializuje novou instanci CancellationTokenSource třídy, která bude zrušena po zadaném časovém intervalu.Initializes a new instance of the CancellationTokenSource class that will be canceled after the specified time span.

Vlastnosti

IsCancellationRequested

Získá požadavek na zrušení pro tuto možnost CancellationTokenSource .Gets whether cancellation has been requested for this CancellationTokenSource.

Token

Získá CancellationToken přidružený k tomuto CancellationTokenSource .Gets the CancellationToken associated with this CancellationTokenSource.

Metody

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.

CancelAfter(Int32)

Naplánuje operaci zrušení na tomto CancellationTokenSource po zadaném počtu milisekund.Schedules a cancel operation on this CancellationTokenSource after the specified number of milliseconds.

CancelAfter(TimeSpan)

Naplánuje u této operace zrušení CancellationTokenSource po zadaném časovém intervalu.Schedules a cancel operation on this CancellationTokenSource after the specified time span.

CreateLinkedTokenSource(CancellationToken)

Vytvoří CancellationTokenSource , který bude ve zrušeném stavu, pokud je poskytnutý token ve stavu Canceled.Creates a CancellationTokenSource that will be in the canceled state when the supplied token is in the canceled state.

CreateLinkedTokenSource(CancellationToken, CancellationToken)

Vytvoří objekt CancellationTokenSource , který bude ve stavu Canceled, pokud jsou všechny zdrojové tokeny ve stavu zrušeno.Creates a CancellationTokenSource that will be in the canceled state when any of the source tokens are in the canceled state.

CreateLinkedTokenSource(CancellationToken[])

Vytvoří objekt CancellationTokenSource , který bude ve stavu Canceled, pokud jsou všechny zdrojové tokeny v zadaném poli ve stavu Canceled.Creates a CancellationTokenSource that will be in the canceled state when any of the source tokens in the specified array are in the canceled state.

Dispose()

Uvolní všechny prostředky používané aktuální instancí CancellationTokenSource třídy.Releases all resources used by the current instance of the CancellationTokenSource class.

Dispose(Boolean)

Uvolní nespravované prostředky používané CancellationTokenSource třídou a volitelně uvolňuje spravované prostředky.Releases the unmanaged resources used by the CancellationTokenSource class and optionally releases the managed resources.

Equals(Object)

Určí, zda se zadaný objekt rovná aktuálnímu objektu.Determines whether the specified object is equal to the current object.

(Zděděno od Object)
GetHashCode()

Slouží jako výchozí funkce hash.Serves as the default hash function.

(Zděděno od Object)
GetType()

Získá Type aktuální instanci.Gets the Type of the current instance.

(Zděděno od Object)
MemberwiseClone()

Vytvoří kopii aktuálního seznamu Object .Creates a shallow copy of the current Object.

(Zděděno od Object)
ToString()

Vrátí řetězec, který představuje aktuální objekt.Returns a string that represents the current object.

(Zděděno od Object)

Platí pro

Bezpečný přístup z více vláken

Všechny veřejné a chráněné členy CancellationTokenSource jsou bezpečné pro přístup z více vláken a mohou být použity souběžně z více vláken s výjimkou Dispose() , která musí být použita pouze v případě, že CancellationTokenSource byly dokončeny všechny ostatní operace objektu.All public and protected members of CancellationTokenSource are thread-safe and may be used concurrently from multiple threads, with the exception of Dispose(), which must only be used when all other operations on the CancellationTokenSource object have completed.