CancellationTokenSource.Cancel Metodo
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Comunica una richiesta di annullamento.
Overload
| Cancel() |
Comunica una richiesta di annullamento. |
| Cancel(Boolean) |
Passa una richiesta di annullamento e specifica se i callback restanti e le operazioni annullabili devono essere elaborati se si verifica un'eccezione. |
Cancel()
Comunica una richiesta di annullamento.
public:
void Cancel();public void Cancel ();member this.Cancel : unit -> unitPublic Sub Cancel ()Eccezioni
Questo oggetto CancellationTokenSource è stato eliminato.
Eccezione di aggregazione che contiene tutte le eccezioni generate dai callback registrati sull'oggetto CancellationToken associato.
Esempio
Nell'esempio seguente viene usato un generatore di numeri casuali per emulare un'applicazione di raccolta dati che legge 10 valori integrali da undici strumenti diversi. Un valore pari a zero indica che la misurazione non è riuscita per uno strumento, nel qual caso l'operazione deve essere annullata e non deve essere calcolata alcuna media complessiva.
Per gestire l'annullamento possibile dell'operazione, l'esempio crea un'istanza di un oggetto che genera un CancellationTokenSource token di annullamento passato a un TaskFactory oggetto. L'oggetto TaskFactory a sua volta passa il token di annullamento a ognuna delle attività responsabili della raccolta di letture per uno strumento specifico. Il TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken) metodo viene chiamato per assicurarsi che la media venga calcolata solo dopo che tutte le letture sono state raccolte correttamente. Se un'attività non è stata annullata, la chiamata al TaskFactory.ContinueWhenAll metodo genera un'eccezione.
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.
Commenti
L'oggetto associato CancellationToken riceverà una notifica dell'annullamento e passerà a uno stato in cui IsCancellationRequested restituisce true.
Tutte le operazioni di callback o annullabili registrate con l'oggetto CancellationToken verranno eseguite.
È consigliabile annullare operazioni e callback registrati con CancellationToken non generare eccezioni.
Questo overload di Cancel aggrega eventuali eccezioni generate in un AggregateExceptionoggetto , in modo che un callback che genera un'eccezione non impedisce l'esecuzione di altri callback registrati.
La chiamata a questo metodo ha lo stesso effetto della chiamata Cancel(false)a .
Vedi anche
Si applica a
Cancel(Boolean)
Passa una richiesta di annullamento e specifica se i callback restanti e le operazioni annullabili devono essere elaborati se si verifica un'eccezione.
public:
void Cancel(bool throwOnFirstException);public void Cancel (bool throwOnFirstException);member this.Cancel : bool -> unitPublic Sub Cancel (throwOnFirstException As Boolean)Parametri
- throwOnFirstException
- Boolean
true se le eccezioni devono essere propagate immediatamente; in caso contrario, false.
Eccezioni
Questo oggetto CancellationTokenSource è stato eliminato.
Eccezione di aggregazione che contiene tutte le eccezioni generate dai callback registrati sull'oggetto CancellationToken associato.
Commenti
L'oggetto associato CancellationToken riceverà una notifica dell'annullamento e passerà a uno stato in cui IsCancellationRequested restituisce true.
Tutte le operazioni di callback o annullabili registrate con l'oggetto CancellationToken verranno eseguite. I callback verranno eseguiti in modo sincrono nell'ordine LIFO.
È consigliabile annullare operazioni e callback registrati con CancellationToken non generare eccezioni.
Se throwOnFirstException è true, un'eccezione si propaga immediatamente fuori dalla chiamata a Cancel, impedisce l'elaborazione dei callback rimanenti e le operazioni annullabili.
Se throwOnFirstException è false, questo overload aggrega eventuali eccezioni generate in un AggregateExceptionoggetto , in modo che un callback che genera un'eccezione non impedisce l'esecuzione di altri callback registrati.