CancellationTokenSource Kelas
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.
Sinyal ke CancellationToken bahwa itu harus dibatalkan.
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
- Warisan
-
CancellationTokenSource
- Atribut
- Penerapan
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, contohnya membuat CancellationTokenSource instans 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 selesai 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
Dimulai dengan .NET Framework 4, .NET Framework menggunakan model terpadu untuk pembatalan kooperatif operasi sinkron asinkron atau jangka panjang yang melibatkan dua objek:
ObjekCancellationTokenSource, yang menyediakan token pembatalan melalui propertinya Token dan mengirim pesan pembatalan dengan memanggil metode atau CancelAfter .Cancel
Objek CancellationToken , yang menunjukkan apakah pembatalan diminta.
Pola umum untuk menerapkan model pembatalan kooperatif adalah:
Membuat instans objek CancellationTokenSource, yang mengelola dan mengirim pemberitahuan pembatalan ke token pembatalan individu.
Teruskan token yang dikembalikan oleh properti CancellationTokenSource.Token ke setiap tugas atau utas yang mendengarkan pembatalan.
CancellationToken.IsCancellationRequested Panggil metode dari operasi yang menerima token pembatalan. Berikan mekanisme untuk setiap tugas atau utas untuk menanggapi permintaan pembatalan. Apakah Anda memilih untuk membatalkan operasi, dan persis bagaimana Anda melakukannya, tergantung pada logika aplikasi Anda.
Panggil metode CancellationTokenSource.Cancel untuk memberikan pemberitahuan pembatalan. Ini mengatur CancellationToken.IsCancellationRequested properti pada setiap salinan token pembatalan ke
true
.Dispose Panggil metode ketika Anda selesai dengan CancellationTokenSource objek .
Untuk informasi selengkapnya, lihat Pembatalan di Utas Terkelola .
Penting
Jenis ini mengimplementasikan IDisposable antarmuka. Setelah selesai menggunakan instans jenis , Anda harus membuangnya baik secara langsung maupun tidak langsung. Untuk membuang jenis secara langsung, panggil metodenya Dispose dalam try
/finally
blok. Untuk membuangnya secara tidak langsung, gunakan konstruksi bahasa seperti using
(di C#) atau Using
(di Visual Basic). Untuk informasi selengkapnya, lihat bagian "Menggunakan Objek yang Mengimplementasikan IDisposable" di IDisposable topik antarmuka.
Konstruktor
CancellationTokenSource() |
Menginisialisasi instans baru kelas CancellationTokenSource. |
CancellationTokenSource(Int32) |
Menginisialisasi instans CancellationTokenSource baru kelas yang akan dibatalkan setelah penundaan yang ditentukan dalam milidetik. |
CancellationTokenSource(TimeSpan) |
Menginisialisasi instans CancellationTokenSource baru kelas yang akan dibatalkan setelah rentang waktu yang ditentukan. |
CancellationTokenSource(TimeSpan, TimeProvider) |
Menginisialisasi instans CancellationTokenSource baru kelas yang akan dibatalkan setelah yang ditentukan TimeSpan. |
Properti
IsCancellationRequested |
Mendapatkan apakah pembatalan telah diminta untuk ini CancellationTokenSource. |
Token |
Mendapatkan yang CancellationToken terkait dengan ini CancellationTokenSource. |
Metode
Cancel() |
Mengkomunikasikan permintaan pembatalan. |
Cancel(Boolean) |
Mengkomunikasikan permintaan pembatalan, dan menentukan apakah panggilan balik yang tersisa dan operasi yang dapat dibatalkan harus diproses jika pengecualian terjadi. |
CancelAfter(Int32) |
Menjadwalkan operasi pembatalan pada ini CancellationTokenSource setelah jumlah milidetik yang ditentukan. |
CancelAfter(TimeSpan) |
Menjadwalkan operasi pembatalan pada ini CancellationTokenSource setelah rentang waktu yang ditentukan. |
CancelAsync() |
Mengkomunikasikan permintaan pembatalan secara asinkron. |
CreateLinkedTokenSource(CancellationToken) |
CancellationTokenSource Membuat yang akan berada dalam status dibatalkan ketika token yang disediakan dalam status dibatalkan. |
CreateLinkedTokenSource(CancellationToken, CancellationToken) |
CancellationTokenSource Membuat yang akan berada dalam status dibatalkan ketika salah satu token sumber berada dalam status dibatalkan. |
CreateLinkedTokenSource(CancellationToken[]) |
CancellationTokenSource Membuat yang akan berada dalam status dibatalkan ketika salah satu token sumber dalam array yang ditentukan berada dalam status dibatalkan. |
CreateLinkedTokenSource(ReadOnlySpan<CancellationToken>) |
Sinyal ke CancellationToken bahwa itu harus dibatalkan. |
Dispose() |
Merilis semua sumber daya yang digunakan oleh instans CancellationTokenSource kelas saat ini. |
Dispose(Boolean) |
Merilis sumber daya tidak terkelola yang digunakan oleh CancellationTokenSource kelas dan secara opsional merilis sumber daya terkelola. |
Equals(Object) |
Menentukan apakah objek yang ditentukan sama dengan objek saat ini. (Diperoleh dari Object) |
GetHashCode() |
Berfungsi sebagai fungsi hash default. (Diperoleh dari Object) |
GetType() |
Mendapatkan dari instans Type saat ini. (Diperoleh dari Object) |
MemberwiseClone() |
Membuat salinan dangkal dari saat ini Object. (Diperoleh dari Object) |
ToString() |
Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object) |
TryReset() |
Upaya untuk mereset yang CancellationTokenSource akan digunakan untuk operasi yang tidak terkait. |
Berlaku untuk
Keamanan Thread
Semua anggota CancellationTokenSource publik dan terlindungi aman dari utas dan dapat digunakan secara bersamaan dari beberapa utas, dengan pengecualian Dispose(), yang hanya boleh digunakan ketika semua operasi lain pada CancellationTokenSource objek telah selesai.
Lihat juga
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk