CancellationTokenSource Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Signalizuje, CancellationToken že by měl být zrušen.
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ácti různých nástrojů. Hodnota nula znamená, že měření u jednoho přístroje selhalo. V takovém případě by se operace měla zrušit a neměl by se vypočítat žádný celkový průměr.
Pro zpracování možného zrušení operace, příklad vytvoří instanci objektu CancellationTokenSource , který generuje token zrušení, který je předán objektu TaskFactory . Objekt TaskFactory pak předá token zrušení každému úkolu zodpovědnému za shromažďování hodnot pro konkrétní nástroj. Metoda TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken) je volána, aby se zajistilo, že se průměr vypočítá až po úspěšném shromáždění všech odečtů. Pokud úkol nebyl dokončen, protože byl zrušen, volání TaskFactory.ContinueWhenAll metody vyvolá výjimku.
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 rozhraním .NET Framework 4 používá rozhraní .NET Framework jednotný model pro spolupráci zrušení asynchronních nebo dlouhotrvajících synchronních operací, které zahrnují dva objekty:
Objekt CancellationTokenSource , který poskytuje token zrušení prostřednictvím své Token vlastnosti a odešle zprávu zrušení voláním metody Cancel nebo CancelAfter .
Objekt CancellationToken , který označuje, zda je požadováno zrušení.
Obecný vzor pro implementaci modelu zrušení spolupráce je:
Vytvořte instanci objektu CancellationTokenSource , který spravuje a odesílá oznámení o zrušení jednotlivým tokenům zrušení.
Předejte token vrácený CancellationTokenSource.Token vlastností do každého úkolu nebo vlákna, které naslouchá zrušení.
Volejte metodu CancellationToken.IsCancellationRequested z operací, které obdrží token zrušení. Zadejte mechanismus pro každou úlohu nebo vlákno, které bude reagovat na žádost o zrušení. To, jestli se rozhodnete operaci zrušit a jak přesně ji provedete, závisí na logice vaší aplikace.
Voláním CancellationTokenSource.Cancel metody poskytněte oznámení o zrušení. Tím se vlastnost u CancellationToken.IsCancellationRequested každé kopie tokenu zrušení nastaví na
true
.Po dokončení práce s objektem Dispose volejte metodu CancellationTokenSource .
Další informace najdete v tématu Zrušení ve spravovaných vláknech.
Důležité
Tento typ implementuje IDisposable rozhraní . Jakmile dokončíte používání instance typu , měli byste ji odstranit přímo nebo nepřímo. Chcete-li odstranit typ přímo, zavolejte jeho Dispose metodu try
/finally
v bloku. Pokud ho chcete odstranit nepřímo, použijte konstruktor jazyka, jako using
je (v jazyce C#) nebo Using
(v jazyce Visual Basic). Další informace najdete v části "Použití objektu, který implementuje IDisposable" v IDisposable tématu rozhraní.
Konstruktory
CancellationTokenSource() |
Inicializuje novou instanci CancellationTokenSource třídy . |
CancellationTokenSource(Int32) |
Inicializuje novou instanci CancellationTokenSource třídy, která bude zrušena po zadané prodlevě v milisekundách. |
CancellationTokenSource(TimeSpan) |
Inicializuje novou instanci CancellationTokenSource třídy, která bude zrušena po zadaném časovém rozsahu. |
CancellationTokenSource(TimeSpan, TimeProvider) |
Inicializuje novou instanci CancellationTokenSource třídy, která bude zrušena po zadané TimeSpan. |
Vlastnosti
IsCancellationRequested |
Získá, zda bylo požadováno zrušení pro tento CancellationTokenSource. |
Token |
Získá přidružený k CancellationToken tomuto CancellationTokenSource. |
Metody
Cancel() |
Informuje o žádosti o zrušení. |
Cancel(Boolean) |
Informuje o žádosti o zrušení a určuje, jestli se mají zpracovat zbývající zpětná volání a zrušitelné operace, pokud dojde k výjimce. |
CancelAfter(Int32) |
Naplánuje operaci zrušení po CancellationTokenSource zadaném počtu milisekund. |
CancelAfter(TimeSpan) |
Naplánuje operaci CancellationTokenSource zrušení po zadaném časovém rozsahu. |
CancelAsync() |
Předává požadavek na zrušení asynchronně. |
CreateLinkedTokenSource(CancellationToken) |
Vytvoří , CancellationTokenSource který bude v zrušeném stavu, když je zadaný token ve zrušeném stavu. |
CreateLinkedTokenSource(CancellationToken, CancellationToken) |
Vytvoří , CancellationTokenSource který bude v zrušeném stavu, když některý ze zdrojových tokenů bude v zrušeném stavu. |
CreateLinkedTokenSource(CancellationToken[]) |
Vytvoří , CancellationTokenSource který bude v zrušeném stavu, pokud jsou všechny zdrojové tokeny v zadaném poli v zrušeném stavu. |
Dispose() |
Uvolní všechny prostředky používané aktuální instancí CancellationTokenSource třídy . |
Dispose(Boolean) |
Uvolní nespravované prostředky používané CancellationTokenSource třídou a volitelně uvolní spravované prostředky. |
Equals(Object) |
Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object) |
GetHashCode() |
Slouží jako výchozí hashovací funkce. (Zděděno od Object) |
GetType() |
Type Získá z aktuální instance. (Zděděno od Object) |
MemberwiseClone() |
Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object) |
ToString() |
Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object) |
TryReset() |
Pokusí se resetovat CancellationTokenSource , aby se použil pro nesouvisející operaci. |
Platí pro
Bezpečný přístup z více vláken
Všechny veřejné a chráněné členy souboru CancellationTokenSource jsou bezpečné pro přístup z více vláken a mohou být použity současně z více vláken s výjimkou Dispose(), která se musí použít pouze v případě, že byly dokončeny všechny ostatní operace s objektem CancellationTokenSource .
Viz také
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro