CancellationToken 構造体

定義

操作を取り消す通知を配信します。

public value class CancellationToken
public struct CancellationToken
[System.Runtime.InteropServices.ComVisible(false)]
public struct CancellationToken
type CancellationToken = struct
[<System.Runtime.InteropServices.ComVisible(false)>]
type CancellationToken = struct
Public Structure CancellationToken
継承
CancellationToken
属性

次の例では、乱数ジェネレーターを使用して、11 個の異なるインストルメントから 10 個の整数値を読み取るデータ収集アプリケーションをエミュレートします。 値 0 は、1 つのインストルメントの測定が失敗した場合、操作を取り消し、全体的な平均を計算する必要がないことを示します。

操作のキャンセルの可能性を処理するために、この例では、 オブジェクトに渡されるキャンセル トークンを生成する オブジェクト CancellationTokenSource をインスタンス化 TaskFactory します。 さらに、 オブジェクトは、特定のインストルメントの読み取り値の収集を担当する各タスクにキャンセル TaskFactory トークンを渡します。 メソッドが呼び出され、すべての測定値が正常に収集された後にのみ平均が TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken) 計算されます。 取り消されたためタスクが完了していない場合、 メソッド TaskFactory.ContinueWhenAll は例外をスローします。

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.

注釈

CancellationToken 使用すると、スレッド、スレッド プールの作業項目、またはオブジェクト間の協調的な取り消しが可能 Task になります。 キャンセル トークンを作成するには、 オブジェクトをインスタンス化します。このオブジェクトは、その プロパティから取得されたキャンセル CancellationTokenSource トークンを管理 CancellationTokenSource.Token します。 その後、キャンセル通知を受け取る必要がある任意の数のスレッド、タスク、または操作にキャンセル トークンを渡します。 トークンを使用してキャンセルを開始することはできません。 所有しているオブジェクトが を呼び出 CancellationTokenSource.Cancel す場合、キャンセル トークンのすべてのコピーの IsCancellationRequested プロパティは に設定されます true 。 通知を受け取るオブジェクトは、適切な方法で応答できます。

詳細とコード例については、「マネージド スレッドでの 取り消し」を参照してください

コンストラクター

CancellationToken(Boolean)

CancellationToken を初期化します。

プロパティ

CanBeCanceled

このトークンが取り消された状態になることができるかどうかを取得します。

IsCancellationRequested

このトークンに対して取り消しが要求されたかどうかを取得します。

None

空の CancellationToken 値を返します。

WaitHandle

トークンが取り消されたときに通知される WaitHandle を取得します。

メソッド

Equals(CancellationToken)

現在の CancellationToken インスタンスが指定されたトークンと等しいかどうかを判断します。

Equals(Object)

現在の CancellationToken インスタンスが指定された Object と等しいかどうかを判断します。

GetHashCode()

CancellationToken のハッシュ関数として機能します。

Register(Action)

この CancellationToken が取り消されたときに呼び出されるデリゲートを登録します。

Register(Action, Boolean)

この CancellationToken が取り消されたときに呼び出されるデリゲートを登録します。

Register(Action<Object,CancellationToken>, Object)

この CancellationToken が取り消されたときに呼び出されるデリゲートを登録します。

Register(Action<Object>, Object)

この CancellationToken が取り消されたときに呼び出されるデリゲートを登録します。

Register(Action<Object>, Object, Boolean)

この CancellationToken が取り消されたときに呼び出されるデリゲートを登録します。

ThrowIfCancellationRequested()

このトークンに対して取り消しが要求された場合、OperationCanceledException をスローします。

UnsafeRegister(Action<Object,CancellationToken>, Object)

この CancellationToken が取り消されたときに呼び出されるデリゲートを登録します。

UnsafeRegister(Action<Object>, Object)

この CancellationToken が取り消されたときに呼び出されるデリゲートを登録します。

演算子

Equality(CancellationToken, CancellationToken)

2 つの CancellationToken インスタンスが等しいかどうかを判断します。

Inequality(CancellationToken, CancellationToken)

2 つの CancellationToken インスタンスが等しくないかどうかを判断します。

適用対象

スレッド セーフ

のすべてのパブリック メンバーと保護されたメンバー CancellationToken はスレッド セーフであり、複数のスレッドから同時に使用できます。

こちらもご覧ください