CancellationToken Структура
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Распространяет уведомление о том, что операции следует отменить.
public value class CancellationToken
public value class CancellationToken : IEquatable<System::Threading::CancellationToken>
public struct CancellationToken
public readonly struct CancellationToken
public readonly struct CancellationToken : IEquatable<System.Threading.CancellationToken>
[System.Runtime.InteropServices.ComVisible(false)]
public struct CancellationToken
type CancellationToken = struct
[<System.Runtime.InteropServices.ComVisible(false)>]
type CancellationToken = struct
Public Structure CancellationToken
Public Structure CancellationToken
Implements IEquatable(Of CancellationToken)
- Наследование
- Атрибуты
- Реализации
Примеры
В следующем примере используется генератор случайных чисел для эмуляции приложения для сбора данных, которое считывает 10 целочисленных значений из одиннадцати различных инструментов. Значение, равное нулю, указывает, что измерение завершилось сбоем для одного инструмента. В этом случае операцию следует отменить и не вычислить общее среднее значение.
Для обработки возможной отмены операции в примере создается 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) |
Определяет, равны ли два экземпляра CancellationToken. |
Inequality(CancellationToken, CancellationToken) |
Определяет, действительно ли два экземпляра CancellationToken не равны. |
Применяется к
Потокобезопасность
Все общедоступные и защищенные члены CancellationToken являются потокобезопасными и могут использоваться одновременно из нескольких потоков.