CancellationTokenSource.Cancel メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
キャンセル要求を伝えます。
オーバーロード
| Cancel() |
キャンセル要求を伝えます。 |
| Cancel(Boolean) |
キャンセル要求を伝え、例外が発生した場合に残りのコールバックとキャンセル可能な操作を続けるかどうかを指定します。 |
Cancel()
キャンセル要求を伝えます。
public:
void Cancel();public void Cancel ();member this.Cancel : unit -> unitPublic Sub Cancel ()例外
この CancellationTokenSource は破棄されています。
関連付けられたCancellationToken に登録されたコールバックがスローしたすべての例外を含む集計例外。
例
次の例では、乱数ジェネレーターを使用して、11 個の異なる計測器から 10 個の整数値を読み取るデータ収集アプリケーションをエミュレートします。 0 の値は、測定が 1 つの計測器に対して失敗したことを示します。その場合、操作を取り消し、全体的な平均を計算する必要はありません。
操作のキャンセルの可能性を処理するために、この例では、オブジェクトに渡されるキャンセル トークンを生成するオブジェクトをTaskFactoryインスタンス化CancellationTokenSourceします。 オブジェクトは 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にキャンセルを通知し、IsCancellationRequestedがtrueを返す状態に遷移します。
CancellationTokenに登録されてたすべてのコールバックおよびキャンセル可能な操作が実行されます。
CancellationTokenに登録されるコールバックおよびキャンセル可能な操作では、例外をスローしないことが推奨されています。
Cancelのこのオーバー ロードでは、スローされた例外がすべてAggregateExceptionに集約されます。1つのコールバックで例外がスローされても、他のコールバックの実行が妨げられることはありません。
このメソッドを呼び出すと、呼び出し Cancel(false)と同じ効果があります。
こちらもご覧ください
適用対象
Cancel(Boolean)
キャンセル要求を伝え、例外が発生した場合に残りのコールバックとキャンセル可能な操作を続けるかどうかを指定します。
public:
void Cancel(bool throwOnFirstException);public void Cancel (bool throwOnFirstException);member this.Cancel : bool -> unitPublic Sub Cancel (throwOnFirstException As Boolean)パラメーター
- throwOnFirstException
- Boolean
例外を直ちに伝達する場合は true 。それ以外の場合は false。
例外
この CancellationTokenSource は破棄されています。
関連付けられたCancellationToken に登録されたコールバックがスローしたすべての例外を含む集計例外。
注釈
関連付けられてたCancellationTokenにキャンセルを通知し、IsCancellationRequestedがtrueを返す状態に遷移します。
CancellationTokenに登録されてたすべてのコールバックおよびキャンセル可能な操作が実行されます。 コールバックは LIFO 順序で同期的に実行されます。
CancellationTokenに登録されるコールバックおよびキャンセル可能な操作では、例外をスローしないことが推奨されています。
throwOnFirstExceptionがtrueの場合、例外はCancelの呼び出し外へとすぐに伝達され、残りのコールバックとキャンセル可能な操作は処理されません。
throwOnFirstExceptionがfalseの場合、スローされた例外がすべてAggregateExceptionに集約されます。1つのコールバックで例外がスローされても、他のコールバックの実行が妨げられることはありません。