CancellationTokenSource.Cancel Metode
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Mengkomunikasikan permintaan pembatalan.
Overload
| Nama | Deskripsi |
|---|---|
| Cancel() |
Mengkomunikasikan permintaan pembatalan. |
| Cancel(Boolean) |
Mengkomunikasikan permintaan pembatalan, dan menentukan apakah panggilan balik yang tersisa dan operasi yang dapat dibatalkan harus diproses jika terjadi pengecualian. |
Cancel()
- Sumber:
- CancellationTokenSource.cs
- Sumber:
- CancellationTokenSource.cs
- Sumber:
- CancellationTokenSource.cs
- Sumber:
- CancellationTokenSource.cs
- Sumber:
- CancellationTokenSource.cs
Mengkomunikasikan permintaan pembatalan.
public:
void Cancel();public void Cancel();member this.Cancel : unit -> unitPublic Sub Cancel ()Pengecualian
Ini CancellationTokenSource telah dibuang.
Pengecualian agregat yang berisi semua pengecualian yang dilemparkan oleh panggilan balik terdaftar pada yang terkait CancellationToken.
Contoh
Contoh berikut menggunakan generator angka acak untuk meniru aplikasi pengumpulan data yang membaca 10 nilai integral dari sebelas instrumen yang berbeda. Nilai nol menunjukkan bahwa pengukuran telah gagal untuk satu instrumen, dalam hal ini operasi harus dibatalkan dan tidak ada rata-rata keseluruhan yang harus dihitung.
Untuk menangani kemungkinan pembatalan operasi, contoh membuat instans CancellationTokenSource objek yang menghasilkan token pembatalan yang diteruskan ke TaskFactory objek. Objek TaskFactory pada gilirannya meneruskan token pembatalan ke setiap tugas yang bertanggung jawab untuk mengumpulkan pembacaan untuk instrumen tertentu. Metode TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken) ini dipanggil untuk memastikan bahwa rata-rata dihitung hanya setelah semua pembacaan berhasil dikumpulkan. Jika tugas belum karena telah dibatalkan, panggilan ke TaskFactory.ContinueWhenAll metode akan melemparkan pengecualian.
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.
Keterangan
Yang terkait CancellationToken diberi tahu tentang pembatalan dan transisi ke status di mana IsCancellationRequested mengembalikan true.
Setiap panggilan balik atau operasi yang dapat dibatalkan yang terdaftar dengan CancellationToken dijalankan, jika mereka belum dijalankan oleh panggilan sebelumnya ke Cancel(). Panggilan berikutnya untuk Cancel() tidak akan menjalankan panggilan balik yang sama lagi kecuali didaftarkan ulang. (Hindari beberapa panggilan ke Cancel(), karena niat kode tersebut sering tidak jelas.)
Panggilan balik dijalankan secara sinkron dalam urutan LIFO.
Kami menyarankan agar operasi yang dapat dibatalkan dan panggilan balik yang terdaftar CancellationToken dengan tidak melemparkan pengecualian.
Kelebihan pembatalan ini mengagregasi pengecualian apa pun yang dilemparkan ke dalam AggregateException, sehingga satu panggilan balik yang melemparkan pengecualian tidak akan mencegah panggilan balik terdaftar lainnya dijalankan.
Memanggil metode ini memiliki efek yang sama dengan memanggil Cancel(false).
Lihat juga
Berlaku untuk
Cancel(Boolean)
- Sumber:
- CancellationTokenSource.cs
- Sumber:
- CancellationTokenSource.cs
- Sumber:
- CancellationTokenSource.cs
- Sumber:
- CancellationTokenSource.cs
- Sumber:
- CancellationTokenSource.cs
Mengkomunikasikan permintaan pembatalan, dan menentukan apakah panggilan balik yang tersisa dan operasi yang dapat dibatalkan harus diproses jika terjadi pengecualian.
public:
void Cancel(bool throwOnFirstException);public void Cancel(bool throwOnFirstException);member this.Cancel : bool -> unitPublic Sub Cancel (throwOnFirstException As Boolean)Parameter
- throwOnFirstException
- Boolean
true jika pengecualian harus segera disebarluaskan; jika tidak, false.
Pengecualian
Ini CancellationTokenSource telah dibuang.
Pengecualian agregat yang berisi semua pengecualian yang dilemparkan oleh panggilan balik terdaftar pada yang terkait CancellationToken.
Keterangan
Yang terkait CancellationToken diberi tahu tentang pembatalan dan transisi ke status di mana IsCancellationRequested mengembalikan true.
Setiap panggilan balik atau operasi yang dapat dibatalkan yang terdaftar dengan CancellationToken dijalankan, jika mereka belum dijalankan oleh panggilan sebelumnya ke Cancel(). Panggilan berikutnya untuk Cancel() tidak akan menjalankan panggilan balik yang sama lagi kecuali didaftarkan ulang. (Hindari beberapa panggilan ke Cancel(), karena niat kode tersebut sering tidak jelas.)
Panggilan balik dijalankan secara sinkron dalam urutan LIFO.
Kami menyarankan agar operasi yang dapat dibatalkan dan panggilan balik yang terdaftar CancellationToken dengan tidak melemparkan pengecualian.
Jika throwOnFirstException adalah true, pengecualian akan segera disebarluaskan dari panggilan ke Cancel, mencegah panggilan balik yang tersisa dan operasi yang dapat dibatalkan diproses.
Jika throwOnFirstException adalah false, kelebihan beban ini mengagregasi pengecualian apa pun yang dilemparkan ke dalam AggregateException, sehingga satu panggilan balik yang melemparkan pengecualian tidak akan mencegah panggilan balik terdaftar lainnya dijalankan.
