CancellationTokenSource Kelas

Definisi

Ruang nama:

System.Threading

Rakitan:

System.Runtime.dll

Sumber:

CancellationTokenSource.cs

Sinyal ke CancellationToken bahwa itu harus dibatalkan.

public ref class CancellationTokenSource : IDisposable

public class CancellationTokenSource : IDisposable

type CancellationTokenSource = class
    interface IDisposable

Public Class CancellationTokenSource
Implements IDisposable

Warisan

Object

CancellationTokenSource

Penerapan

IDisposable

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 objek CancellationTokenSource yang menghasilkan token pembatalan yang diteruskan ke objek TaskFactory. 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) dipanggil untuk memastikan bahwa rata-rata dihitung hanya setelah semua pembacaan berhasil dikumpulkan. Jika tugas belum selesai karena telah dibatalkan, panggilan ke metode TaskFactory.ContinueWhenAll 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:

• Objek CancellationTokenSource, yang menyediakan token pembatalan melalui properti Token dan mengirim pesan pembatalan dengan memanggil metode Cancel atau CancelAfter.

• Objek CancellationToken, yang menunjukkan apakah pembatalan diminta.

Pola umum untuk menerapkan model pembatalan koperasi adalah:

• Buat 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.

• Panggil metode CancellationToken.IsCancellationRequested 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 properti CancellationToken.IsCancellationRequested pada setiap salinan token pembatalan ke true.

• Panggil metode Dispose ketika Anda selesai dengan objek CancellationTokenSource.

Untuk informasi selengkapnya, lihat Pembatalan di Utas Terkelola.

Penting

Jenis ini mengimplementasikan antarmuka IDisposable. Setelah selesai menggunakan instans jenis, Anda harus membuangnya baik secara langsung maupun tidak langsung. Untuk membuang jenis secara langsung, panggil metode Dispose dalam blok try/finally. Untuk membuangnya secara tidak langsung, gunakan konstruksi bahasa seperti using (dalam C#) atau Using (di Visual Basic). Untuk informasi selengkapnya, lihat bagian "Menggunakan Objek yang Menerapkan IDisposable" di topik antarmuka IDisposable.

Konstruktor

CancellationTokenSource()	Menginisialisasi instans baru kelas CancellationTokenSource.
CancellationTokenSource(Int32)	Menginisialisasi instans baru kelas CancellationTokenSource yang akan dibatalkan setelah penundaan yang ditentukan dalam milidetik.
CancellationTokenSource(TimeSpan)	Menginisialisasi instans baru kelas CancellationTokenSource yang akan dibatalkan setelah rentang waktu yang ditentukan.
CancellationTokenSource(TimeSpan, TimeProvider)	Menginisialisasi instans baru kelas CancellationTokenSource yang akan dibatalkan setelah TimeSpanyang ditentukan.

Properti

IsCancellationRequested	Mendapatkan apakah pembatalan telah diminta untuk CancellationTokenSourceini.
Token	Mendapatkan CancellationToken yang terkait dengan CancellationTokenSourceini.

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 terjadi pengecualian.
CancelAfter(Int32)	Menjadwalkan operasi pembatalan pada CancellationTokenSource ini setelah jumlah milidetik yang ditentukan.
CancelAfter(TimeSpan)	Menjadwalkan operasi pembatalan pada CancellationTokenSource ini setelah rentang waktu yang ditentukan.
CancelAsync()	Mengkomunikasikan permintaan pembatalan secara asinkron.
CreateLinkedTokenSource(CancellationToken)	Membuat CancellationTokenSource yang akan berada dalam status dibatalkan ketika token yang disediakan dalam status dibatalkan.
CreateLinkedTokenSource(CancellationToken, CancellationToken)	Membuat CancellationTokenSource yang akan berada dalam status dibatalkan ketika salah satu token sumber berada dalam status dibatalkan.
CreateLinkedTokenSource(CancellationToken[])	Membuat CancellationTokenSource yang akan berada dalam status dibatalkan ketika salah satu token sumber dalam array yang ditentukan berada dalam status dibatalkan.
Dispose()	Merilis semua sumber daya yang digunakan oleh instans kelas CancellationTokenSource saat ini.
Dispose(Boolean)	Merilis sumber daya yang tidak dikelola yang digunakan oleh kelas CancellationTokenSource 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 Type instans saat ini. (Diperoleh dari Object)
MemberwiseClone()	Membuat salinan dangkal dari Objectsaat ini. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)
TryReset()	Mencoba mengatur ulang CancellationTokenSource yang akan digunakan untuk operasi yang tidak terkait.

Keamanan Thread

Semua anggota CancellationTokenSource publik dan terlindungi aman utas dan dapat digunakan secara bersamaan dari beberapa utas, dengan pengecualian Dispose(), yang hanya boleh digunakan ketika semua operasi lain pada objek CancellationTokenSource telah selesai.

Lihat juga

• Pembatalan
• Pembatalan Tugas