CancellationToken Struktúra
Definíció
Fontos
Egyes információk olyan, kiadás előtti termékekre vonatkoznak, amelyek a kiadásig még jelentősen módosulhatnak. A Microsoft nem vállal kifejezett vagy törvényi garanciát az itt megjelenő információért.
Propagálja az értesítéseket, amelyek szerint a műveleteket le kell mondani.
public value class CancellationTokenpublic struct CancellationToken[System.Runtime.InteropServices.ComVisible(false)]
public struct CancellationTokenpublic readonly struct CancellationTokentype CancellationToken = struct[<System.Runtime.InteropServices.ComVisible(false)>]
type CancellationToken = structPublic Structure CancellationToken- Öröklődés
- Attribútumok
Példák
Az alábbi példa egy véletlenszerű számgenerátort használ egy adatgyűjtési alkalmazás emulálásához, amely 10 integrál értéket olvas be tizenegy különböző eszközből. A nulla érték azt jelzi, hogy a mérés egy eszköz esetében meghiúsult, ebben az esetben a műveletet le kell mondani, és nincs szükség általános középérték kiszámítására.
A művelet lehetséges lemondásának kezeléséhez a példa létrehoz egy CancellationTokenSource objektumnak átadott TaskFactory lemondási jogkivonatot létrehozó objektumot. Az objektum viszont átadja a lemondási jogkivonatot minden olyan feladatnak, TaskFactory amely egy adott eszköz leolvasásainak gyűjtéséért felelős. A TaskFactory.ContinueWhenAll<TAntecedentResult,TResult>(Task<TAntecedentResult>[], Func<Task<TAntecedentResult>[],TResult>, CancellationToken) metódus azért van meghívva, hogy a középérték csak az összes olvasás sikeres összegyűjtése után legyen kiszámítva. Ha egy tevékenység nem fejeződött be, mert megszakították, a TaskFactory.ContinueWhenAll metódus kivételt jelez.
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.
Megjegyzések
Az A CancellationToken lehetővé teszi a szálak, a szálkészlet munkaelemei vagy Task objektumai közötti együttműködés megszüntetését. Lemondási jogkivonatot úgy hozhat létre, hogy létrehoz egy CancellationTokenSource objektumot, amely kezeli a tulajdonságából CancellationTokenSource.Token lekért lemondási jogkivonatokat. Ezután átadja a lemondási jogkivonatot minden olyan szálnak, feladatnak vagy műveletnek, amely értesítést kap a lemondásról. A jogkivonat nem használható lemondás kezdeményezésére. Amikor a tulajdonos objektum hív CancellationTokenSource.Cancel, a IsCancellationRequested lemondási jogkivonat minden másolatának tulajdonsága a következőre truevan állítva: . Az értesítést kapó objektumok bármilyen megfelelő módon válaszolhatnak.
További információkért és példakódokért lásd : Törlés felügyelt szálakban.
Konstruktorok
| Name | Description |
|---|---|
| CancellationToken(Boolean) |
Inicializálja a CancellationToken. |
Tulajdonságok
| Name | Description |
|---|---|
| CanBeCanceled |
Lekérdezi, hogy ez a jogkivonat képes-e megszakított állapotban lenni. |
| IsCancellationRequested |
Lekérdezi, hogy a jogkivonat törlését kérték-e. |
| None |
Üres CancellationToken értéket ad vissza. |
| WaitHandle |
WaitHandle Lekéri a jogkivonat megszakításakor jelzést kap. |
Metódusok
| Name | Description |
|---|---|
| Equals(CancellationToken) |
Meghatározza, hogy az aktuális CancellationToken példány egyenlő-e a megadott jogkivonattal. |
| Equals(Object) |
Meghatározza, hogy az aktuális CancellationToken példány egyenlő-e a megadottval Object. |
| GetHashCode() |
Kivonatfüggvényként szolgál egy CancellationToken. |
| Register(Action, Boolean) |
Regisztrál egy meghatalmazottat, aki a CancellationToken lemondáskor lesz meghívva. |
| Register(Action) |
Regisztrál egy meghatalmazottat, aki a CancellationToken lemondáskor lesz meghívva. |
| Register(Action<Object>, Object, Boolean) |
Regisztrál egy meghatalmazottat, aki a CancellationToken lemondáskor lesz meghívva. |
| Register(Action<Object>, Object) |
Regisztrál egy meghatalmazottat, aki a CancellationToken lemondáskor lesz meghívva. |
| ThrowIfCancellationRequested() |
A rendszer a OperationCanceledException jogkivonat lemondását kéri. |
Operátorok
| Name | Description |
|---|---|
| Equality(CancellationToken, CancellationToken) |
Meghatározza, hogy két CancellationToken példány egyenlő-e. |
| Inequality(CancellationToken, CancellationToken) |
Meghatározza, hogy két CancellationToken példány nem egyenlő-e. |
A következőre érvényes:
Szálbiztonság
Az összes nyilvános és védett tagja CancellationToken szálbiztos, és egyidejűleg több szálból is használható.