CancellationToken Struktur

Definisi

Ruang nama:

System.Threading

Rakitan:

netstandard.dll, System.Runtime.dll

Sumber:

CancellationToken.cs

Menyebarkan pemberitahuan bahwa operasi harus dibatalkan.

public value class CancellationToken : IEquatable<System::Threading::CancellationToken>

public readonly struct CancellationToken : IEquatable<System.Threading.CancellationToken>

type CancellationToken = struct

Public Structure CancellationToken
Implements IEquatable(Of CancellationToken)

Warisan

Object

ValueType

CancellationToken

Penerapan

IEquatable<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. Pada gilirannya TaskFactory , objek 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 dibatalkan, 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

Memungkinkan CancellationToken pembatalan kooperatif antara utas, item kerja kumpulan alur, atau Task objek. Anda membuat token pembatalan dengan membuat instans CancellationTokenSource objek, yang mengelola token pembatalan yang diambil dari propertinya CancellationTokenSource.Token . Anda kemudian meneruskan token pembatalan ke sejumlah utas, tugas, atau operasi yang harus menerima pemberitahuan pembatalan. Token tidak dapat digunakan untuk memulai pembatalan. Ketika objek pemilik memanggil CancellationTokenSource.Cancel, IsCancellationRequested properti pada setiap salinan token pembatalan diatur ke true. Objek yang menerima pemberitahuan dapat merespons dengan cara apa pun yang sesuai.

Untuk informasi selengkapnya dan contoh kode lihat Pembatalan di Utas Terkelola.

Konstruktor

Nama	Deskripsi
CancellationToken(Boolean)	Menginisialisasi CancellationToken.

Properti

Nama	Deskripsi
CanBeCanceled	Mendapatkan apakah token ini mampu berada dalam status dibatalkan.
IsCancellationRequested	Mendapatkan apakah pembatalan telah diminta untuk token ini.
None	Mengembalikan nilai kosong CancellationToken .
WaitHandle	WaitHandle Mendapatkan yang disinyalir ketika token dibatalkan.

Metode

Nama	Deskripsi
Equals(CancellationToken)	Menentukan apakah instans saat ini CancellationToken sama dengan token yang ditentukan.
Equals(Object)	Menentukan apakah instans saat ini CancellationToken sama dengan yang ditentukan Object.
GetHashCode()	Berfungsi sebagai fungsi hash untuk CancellationToken.
Register(Action, Boolean)	Mendaftarkan delegasi yang akan dipanggil ketika ini CancellationToken dibatalkan.
Register(Action)	Mendaftarkan delegasi yang akan dipanggil ketika ini CancellationToken dibatalkan.
Register(Action<Object,CancellationToken>, Object)	Mendaftarkan delegasi yang akan dipanggil ketika CancellationToken ini dibatalkan.
Register(Action<Object>, Object, Boolean)	Mendaftarkan delegasi yang akan dipanggil ketika ini CancellationToken dibatalkan.
Register(Action<Object>, Object)	Mendaftarkan delegasi yang akan dipanggil ketika ini CancellationToken dibatalkan.
ThrowIfCancellationRequested()	Melempar jika OperationCanceledException token ini telah meminta pembatalan.
UnsafeRegister(Action<Object,CancellationToken>, Object)	Mendaftarkan delegasi yang akan dipanggil ketika CancellationToken ini dibatalkan.
UnsafeRegister(Action<Object>, Object)	Mendaftarkan delegasi yang dipanggil ketika ini CancellationToken dibatalkan.

Operator

Nama	Deskripsi
Equality(CancellationToken, CancellationToken)	Menentukan apakah dua CancellationToken instans sama.
Inequality(CancellationToken, CancellationToken)	Menentukan apakah dua CancellationToken instans tidak sama.

Keamanan Thread

Semua anggota CancellationToken publik dan terlindungi aman utas dan dapat digunakan secara bersamaan dari beberapa utas.

Lihat juga

• Pembatalan
• Pembatalan Tugas