CancellationTokenSource CancellationTokenSource CancellationTokenSource CancellationTokenSource Class

定義

取り消す必要があることを CancellationToken に通知します。Signals to a CancellationToken that it should be canceled.

public ref class CancellationTokenSource : IDisposable
[System.Runtime.InteropServices.ComVisible(false)]
public class CancellationTokenSource : IDisposable
type CancellationTokenSource = class
    interface IDisposable
Public Class CancellationTokenSource
Implements IDisposable
継承
CancellationTokenSourceCancellationTokenSourceCancellationTokenSourceCancellationTokenSource
属性
実装

次の例では、乱数ジェネレーターを使用して、11個の異なる音色から10個の整数値を読み取るデータコレクションアプリケーションをエミュレートします。The following example uses a random number generator to emulate a data collection application that reads 10 integral values from eleven different instruments. 値が0の場合は、測定が1つの音色で失敗したことを示します。この場合、操作はキャンセルされ、全体的な平均は計算されません。A value of zero indicates that the measurement has failed for one instrument, in which case the operation should be cancelled and no overall mean should be computed.

この例では、操作の取り消しの可能性を処理するCancellationTokenSourceために、 TaskFactoryオブジェクトに渡されるキャンセルトークンを生成するオブジェクトをインスタンス化します。To handle the possible cancellation of the operation, the example instantiates a CancellationTokenSource object that generates a cancellation token which is passed to a TaskFactory object. そのTaskFactory後、オブジェクトは、特定のインストルメントの読み取りを収集する各タスクにキャンセルトークンを渡します。The TaskFactory object in turn passes the cancellation token to each of the tasks responsible for collecting readings for a particular instrument. このTaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken)メソッドは、すべての読み取りが正常に収集された後にのみ平均が計算されるようにするために呼び出されます。The TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken) method is called to ensure that the mean is computed only after all readings have been gathered successfully. タスクが取り消されたことが原因でタスクが完了していTaskFactory.ContinueWhenAllない場合、メソッドの呼び出しは例外をスローします。If a task has not because it has been cancelled, the call to the TaskFactory.ContinueWhenAll method throws an exception.

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.

注釈

.NET Framework 4.NET Framework 4以降、.NET Framework は、次の2つのオブジェクトを含む非同期または長時間実行される同期操作の共同キャンセルに統合モデルを使用します。Starting with the .NET Framework 4.NET Framework 4, the .NET Framework uses a unified model for cooperative cancellation of asynchronous or long-running synchronous operations that involves two objects:

連携によるキャンセル処理モデルを実装するための一般的なパターンは次のとおりです。The general pattern for implementing the cooperative cancellation model is:

  • CancellationTokenSource オブジェクトのインスタンスを作成します。このオブジェクトでは、個々のキャンセル トークンへのキャンセル通知を管理し、送信します。Instantiate a CancellationTokenSource object, which manages and sends cancellation notification to the individual cancellation tokens.

  • CancellationTokenSource.Token プロパティによって返されるトークンを、キャンセルをリッスンしているそれぞれのタスクまたはスレッドに渡します。Pass the token returned by the CancellationTokenSource.Token property to each task or thread that listens for cancellation.

  • キャンセルトークンを受け取る操作からメソッドを呼び出します。CancellationToken.IsCancellationRequestedCall the CancellationToken.IsCancellationRequested method from operations that receive the cancellation token. 各タスクまたはスレッドがキャンセル要求に応答するためのメカニズムを提供します。Provide a mechanism for each task or thread to respond to a cancellation request. 操作の取り消しを選択したかどうかは、アプリケーションロジックによって異なります。Whether you choose to cancel an operation, and exactly how you do it, depends on your application logic.

  • キャンセルの通知を提供する CancellationTokenSource.Cancel メソッドを呼び出します。Call the CancellationTokenSource.Cancel method to provide notification of cancellation. これによりCancellationToken.IsCancellationRequested 、キャンセルトークンのすべてのコピーのプロパティtrueがに設定されます。This sets the CancellationToken.IsCancellationRequested property on every copy of the cancellation token to true.

  • オブジェクトのDispose CancellationTokenSource使用が終了したら、メソッドを呼び出します。Call the Dispose method when you are finished with the CancellationTokenSource object.

詳細については、「マネージド スレッドのキャンセル」を参照してください。For more information, see Cancellation in Managed Threads.

重要

この型は IDisposable インターフェイスを実装します。This type implements the IDisposable interface. 型のインスタンスの使用が完了したら、直接または間接的に破棄する必要があります。When you have finished using an instance of the type, you should dispose of it either directly or indirectly. 直接的に型を破棄するには、try / catch ブロック内で Dispose メソッドを呼び出します。To dispose of the type directly, call its Dispose method in a try/catch block. 間接的に型を破棄するには、using (C# の場合) または Using (Visual Basic 言語) などの言語構成要素を使用します。To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). 詳細については、IDisposable インターフェイスに関するトピック内の「IDisposable を実装するオブジェクトの使用」セクションを参照してください。For more information, see the "Using an Object that Implements IDisposable" section in the IDisposable interface topic.

コンストラクター

CancellationTokenSource() CancellationTokenSource() CancellationTokenSource() CancellationTokenSource()

CancellationTokenSource クラスの新しいインスタンスを初期化します。Initializes a new instance of the CancellationTokenSource class.

CancellationTokenSource(Int32) CancellationTokenSource(Int32) CancellationTokenSource(Int32) CancellationTokenSource(Int32)

指定した遅延 (ミリ秒単位) が経過した後にキャンセルされる CancellationTokenSource クラスの新しいインスタンスを初期化します。Initializes a new instance of the CancellationTokenSource class that will be canceled after the specified delay in milliseconds.

CancellationTokenSource(TimeSpan) CancellationTokenSource(TimeSpan) CancellationTokenSource(TimeSpan) CancellationTokenSource(TimeSpan)

指定した時間間隔の後にキャンセルされる CancellationTokenSource クラスの新しいインスタンスを初期化します。Initializes a new instance of the CancellationTokenSource class that will be canceled after the specified time span.

プロパティ

IsCancellationRequested IsCancellationRequested IsCancellationRequested IsCancellationRequested

この CancellationTokenSource に対して取り消しが要求されているかどうかを取得します。Gets whether cancellation has been requested for this CancellationTokenSource.

Token Token Token Token

この CancellationToken に関連付けられている CancellationTokenSource を取得します。Gets the CancellationToken associated with this CancellationTokenSource.

メソッド

Cancel() Cancel() Cancel() Cancel()

キャンセル要求を伝えます。Communicates a request for cancellation.

Cancel(Boolean) Cancel(Boolean) Cancel(Boolean) Cancel(Boolean)

キャンセル要求を伝え、例外が発生した場合に残りのコールバックとキャンセル可能な操作を続けるかどうかを指定します。Communicates a request for cancellation, and specifies whether remaining callbacks and cancelable operations should be processed if an exception occurs.

CancelAfter(Int32) CancelAfter(Int32) CancelAfter(Int32) CancelAfter(Int32)

指定したミリ秒数の経過後に、この CancellationTokenSource のキャンセル操作を設定します。Schedules a cancel operation on this CancellationTokenSource after the specified number of milliseconds.

CancelAfter(TimeSpan) CancelAfter(TimeSpan) CancelAfter(TimeSpan) CancelAfter(TimeSpan)

指定した時間間隔の経過後に、この CancellationTokenSource のキャンセル操作を設定します。Schedules a cancel operation on this CancellationTokenSource after the specified time span.

CreateLinkedTokenSource(CancellationToken, CancellationToken) CreateLinkedTokenSource(CancellationToken, CancellationToken) CreateLinkedTokenSource(CancellationToken, CancellationToken) CreateLinkedTokenSource(CancellationToken, CancellationToken)

いずれかのソース トークンが取り消された状態であるときに、取り消された状態になる CancellationTokenSource を作成します。Creates a CancellationTokenSource that will be in the canceled state when any of the source tokens are in the canceled state.

CreateLinkedTokenSource(CancellationToken[]) CreateLinkedTokenSource(CancellationToken[]) CreateLinkedTokenSource(CancellationToken[]) CreateLinkedTokenSource(CancellationToken[])

指定された配列のいずれかのソース トークンが取り消された状態であるときに、取り消された状態になる CancellationTokenSource を作成します。Creates a CancellationTokenSource that will be in the canceled state when any of the source tokens in the specified array are in the canceled state.

Dispose() Dispose() Dispose() Dispose()

CancellationTokenSource クラスの現在のインスタンスによって使用されているすべてのリソースを解放します。Releases all resources used by the current instance of the CancellationTokenSource class.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

CancellationTokenSource クラスによって使用されているアンマネージド リソースを解放し、オプションでマネージド リソースも解放します。Releases the unmanaged resources used by the CancellationTokenSource class and optionally releases the managed resources.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象

スレッド セーフ

CancellationTokenSourceパブリックメンバーとプロテクトメンバーはすべてスレッドセーフであり、複数のスレッドから同時に使用することがDispose()できます。ただし、は、 CancellationTokenSourceオブジェクトの他のすべての操作が完了している場合にのみ使用する必要があります。All public and protected members of CancellationTokenSource are thread-safe and may be used concurrently from multiple threads, with the exception of Dispose(), which must only be used when all other operations on the CancellationTokenSource object have completed.

こちらもご覧ください