Task.Run Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Met en file d’attente le travail spécifié à exécuter dans le ThreadPool et retourne une tâche ou un handle de Task<TResult> pour ce travail.
Surcharges
| Run(Action) |
Met en file d'attente le travail spécifié à exécuter dans le pool de threads et retourne un objet Task qui représente ce travail. |
| Run(Func<Task>) |
Met en file d’attente le travail spécifié à exécuter sur le pool de threads et retourne un proxy pour la tâche retournée par |
| Run(Action, CancellationToken) |
Met en file d'attente le travail spécifié à exécuter dans le pool de threads et retourne un objet Task qui représente ce travail. Un jeton d’annulation permet l’annulation du travail s’il n’a pas encore été commencé. |
| Run(Func<Task>, CancellationToken) |
Met en file d’attente le travail spécifié à exécuter sur le pool de threads et retourne un proxy pour la tâche retournée par |
| Run<TResult>(Func<Task<TResult>>) |
Met en file d’attente le travail spécifié à exécuter dans le pool de threads et retourne un proxy pour le |
| Run<TResult>(Func<TResult>) |
Met en file d'attente le travail spécifié à exécuter dans le pool de threads et retourne un objet Task<TResult> qui représente ce travail. Un jeton d’annulation permet l’annulation du travail s’il n’a pas encore été commencé. |
| Run<TResult>(Func<Task<TResult>>, CancellationToken) |
Met en file d’attente le travail spécifié à exécuter dans le pool de threads et retourne un proxy pour le |
| Run<TResult>(Func<TResult>, CancellationToken) |
Met en file d'attente le travail spécifié à exécuter dans le pool de threads et retourne un objet |
Remarques
La Run méthode fournit un ensemble de surcharges qui facilitent le démarrage d’une tâche à l’aide de valeurs par défaut. C’est une alternative légère aux StartNew surcharges.
Run(Action)
Met en file d'attente le travail spécifié à exécuter dans le pool de threads et retourne un objet Task qui représente ce travail.
public:
static System::Threading::Tasks::Task ^ Run(Action ^ action);public static System.Threading.Tasks.Task Run (Action action);static member Run : Action -> System.Threading.Tasks.TaskPublic Shared Function Run (action As Action) As TaskParamètres
- action
- Action
Travail à exécuter de façon asynchrone.
Retours
Tâche qui représente le travail mis en file d'attente à exécuter dans le ThreadPool.
Exceptions
La valeur du paramètre action était null.
Exemples
L’exemple suivant définit une ShowThreadInfo méthode qui affiche le Thread.ManagedThreadId du thread actuel. Il est appelé directement à partir du thread d’application et est appelé à partir du Action délégué passé à la Run(Action) méthode .
using System;
using System.Threading;
using System.Threading.Tasks;
public class Example
{
public static void Main()
{
ShowThreadInfo("Application");
var t = Task.Run(() => ShowThreadInfo("Task") );
t.Wait();
}
static void ShowThreadInfo(String s)
{
Console.WriteLine("{0} thread ID: {1}",
s, Thread.CurrentThread.ManagedThreadId);
}
}
// The example displays the following output:
// Application thread ID: 1
// Task thread ID: 3
open System.Threading
open System.Threading.Tasks
let showThreadInfo s =
printfn $"%s{s} thread ID: {Thread.CurrentThread.ManagedThreadId}"
showThreadInfo "Application"
let t = Task.Run(fun () -> showThreadInfo "Task")
t.Wait()
// The example displays the following output:
// Application thread ID: 1
// Task thread ID: 3
Imports System.Threading
Imports System.Threading.Tasks
Module Example
Public Sub Main()
ShowThreadInfo("Application")
Dim t As Task = Task.Run(Sub() ShowThreadInfo("Task") )
t.Wait()
End Sub
Private Sub ShowThreadInfo(s As String)
Console.WriteLine("{0} Thread ID: {1}",
s, Thread.CurrentThread.ManagedThreadId)
End Sub
End Module
' The example displays output like the following:
' Application thread ID: 1
' Task thread ID: 3
L’exemple suivant est similaire au précédent, sauf qu’il utilise une expression lambda pour définir le code que la tâche doit exécuter.
using System;
using System.Threading;
using System.Threading.Tasks;
public class Example
{
public static void Main()
{
Console.WriteLine("Application thread ID: {0}",
Thread.CurrentThread.ManagedThreadId);
var t = Task.Run(() => { Console.WriteLine("Task thread ID: {0}",
Thread.CurrentThread.ManagedThreadId);
} );
t.Wait();
}
}
// The example displays the following output:
// Application thread ID: 1
// Task thread ID: 3
open System.Threading
open System.Threading.Tasks
printfn $"Application thread ID: {Thread.CurrentThread.ManagedThreadId}"
let t = Task.Run(fun () -> printfn $"Task thread ID: {Thread.CurrentThread.ManagedThreadId}")
t.Wait()
// The example displays the following output:
// Application thread ID: 1
// Task thread ID: 3
Imports System.Threading
Imports System.Threading.Tasks
Module Example
Public Sub Main()
Console.WriteLine("Application thread ID: {0}",
Thread.CurrentThread.ManagedThreadId)
Dim t As Task = Task.Run(Sub()
Console.WriteLine("Task thread ID: {0}",
Thread.CurrentThread.ManagedThreadId)
End Sub)
t.Wait()
End Sub
End Module
' The example displays output like the following:
' Application thread ID: 1
' Task thread ID: 3
Les exemples montrent que la tâche asynchrone s’exécute sur un thread différent de celui du thread d’application main.
L’appel à la Wait méthode garantit que la tâche se termine et affiche sa sortie avant la fin de l’application. Sinon, il est possible que la Main méthode se termine avant la fin de la tâche.
L’exemple suivant illustre la Run(Action) méthode . Il définit un tableau de noms de répertoires et démarre une tâche distincte pour récupérer les noms de fichiers dans chaque répertoire. Toutes les tâches écrivent les noms de fichiers dans un seul ConcurrentBag<T> objet. L’exemple appelle ensuite la WaitAll(Task[]) méthode pour s’assurer que toutes les tâches sont terminées, puis affiche le nombre total de noms de fichiers écrits dans l’objet ConcurrentBag<T> .
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
public class Example
{
public static void Main()
{
var list = new ConcurrentBag<string>();
string[] dirNames = { ".", ".." };
List<Task> tasks = new List<Task>();
foreach (var dirName in dirNames) {
Task t = Task.Run( () => { foreach(var path in Directory.GetFiles(dirName))
list.Add(path); } );
tasks.Add(t);
}
Task.WaitAll(tasks.ToArray());
foreach (Task t in tasks)
Console.WriteLine("Task {0} Status: {1}", t.Id, t.Status);
Console.WriteLine("Number of files read: {0}", list.Count);
}
}
// The example displays output like the following:
// Task 1 Status: RanToCompletion
// Task 2 Status: RanToCompletion
// Number of files read: 23
open System.Collections.Concurrent
open System.IO
open System.Threading.Tasks
let list = ConcurrentBag<string>()
let dirNames = [ "."; ".." ]
let tasks = ResizeArray()
for dirName in dirNames do
let t =
Task.Run(fun () ->
for path in Directory.GetFiles dirName do
list.Add path)
tasks.Add t
tasks.ToArray() |> Task.WaitAll
for t in tasks do
printfn $"Task {t.Id} Status: {t.Status}"
printfn $"Number of files read: {list.Count}"
// The example displays output like the following:
// Task 1 Status: RanToCompletion
// Task 2 Status: RanToCompletion
// Number of files read: 23
Imports System.Collections.Concurrent
Imports System.Collections.Generic
Imports System.IO
Imports System.Threading.Tasks
Module Example
Public Sub Main()
Dim list As New ConcurrentBag(Of String)()
Dim dirNames() As String = { ".", ".." }
Dim tasks As New List(Of Task)()
For Each dirName In dirNames
Dim t As Task = Task.Run( Sub()
For Each path In Directory.GetFiles(dirName)
list.Add(path)
Next
End Sub )
tasks.Add(t)
Next
Task.WaitAll(tasks.ToArray())
For Each t In tasks
Console.WriteLine("Task {0} Status: {1}", t.Id, t.Status)
Next
Console.WriteLine("Number of files read: {0}", list.Count)
End Sub
End Module
' The example displays output like the following:
' Task 1 Status: RanToCompletion
' Task 2 Status: RanToCompletion
' Number of files read: 23
Remarques
La Run méthode vous permet de créer et d’exécuter une tâche dans un appel de méthode unique et constitue une alternative plus simple à la StartNew méthode . Il crée une tâche avec les valeurs par défaut suivantes :
Son jeton d’annulation est CancellationToken.None.
Sa CreationOptions valeur de propriété est TaskCreationOptions.DenyChildAttach.
Il utilise le planificateur de tâches par défaut.
Pour plus d’informations sur la gestion des exceptions levées par des opérations de tâche, consultez Gestion des exceptions.
Voir aussi
S’applique à
Run(Func<Task>)
Met en file d’attente le travail spécifié à exécuter sur le pool de threads et retourne un proxy pour la tâche retournée par function.
public:
static System::Threading::Tasks::Task ^ Run(Func<System::Threading::Tasks::Task ^> ^ function);public static System.Threading.Tasks.Task Run (Func<System.Threading.Tasks.Task> function);public static System.Threading.Tasks.Task Run (Func<System.Threading.Tasks.Task?> function);static member Run : Func<System.Threading.Tasks.Task> -> System.Threading.Tasks.TaskPublic Shared Function Run (function As Func(Of Task)) As TaskParamètres
Retours
Tâche qui représente un proxy de la tâche retournée par function.
Exceptions
La valeur du paramètre function était null.
Remarques
Pour plus d’informations sur la gestion des exceptions levées par des opérations de tâche, consultez Gestion des exceptions.
Voir aussi
S’applique à
Run(Action, CancellationToken)
Met en file d'attente le travail spécifié à exécuter dans le pool de threads et retourne un objet Task qui représente ce travail. Un jeton d’annulation permet l’annulation du travail s’il n’a pas encore été commencé.
public:
static System::Threading::Tasks::Task ^ Run(Action ^ action, System::Threading::CancellationToken cancellationToken);public static System.Threading.Tasks.Task Run (Action action, System.Threading.CancellationToken cancellationToken);static member Run : Action * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Shared Function Run (action As Action, cancellationToken As CancellationToken) As TaskParamètres
- action
- Action
Travail à exécuter de façon asynchrone.
- cancellationToken
- CancellationToken
Un jeton d’annulation peut être utilisé pour annuler le travail s’il n’a pas encore été commencé. Run(Action, CancellationToken) ne passe pas cancellationToken à action.
Retours
Tâche qui représente le travail mis en file d’attente à exécuter dans le pool de threads.
Exceptions
La valeur du paramètre action était null.
La tâche a été annulée.
La CancellationTokenSource associée au cancellationToken a été supprimée.
Exemples
L’exemple suivant appelle la Run(Action, CancellationToken) méthode pour créer une tâche qui itère les fichiers dans le répertoire C:\Windows\System32. L’expression lambda appelle la Parallel.ForEach méthode pour ajouter des informations sur chaque fichier à un List<T> objet . Chaque tâche imbriquée détachée appelée par la Parallel.ForEach boucle vérifie l’état du jeton d’annulation et, si l’annulation est demandée, appelle la CancellationToken.ThrowIfCancellationRequested méthode . La CancellationToken.ThrowIfCancellationRequested méthode lève une OperationCanceledException exception qui est gérée dans un catch bloc lorsque le thread appelant appelle la Task.Wait méthode .
using System;
using System.Collections.Generic;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
public class Example
{
public static async Task Main()
{
var tokenSource = new CancellationTokenSource();
var token = tokenSource.Token;
var files = new List<Tuple<string, string, long, DateTime>>();
var t = Task.Run( () => { string dir = "C:\\Windows\\System32\\";
object obj = new Object();
if (Directory.Exists(dir)) {
Parallel.ForEach(Directory.GetFiles(dir),
f => {
if (token.IsCancellationRequested)
token.ThrowIfCancellationRequested();
var fi = new FileInfo(f);
lock(obj) {
files.Add(Tuple.Create(fi.Name, fi.DirectoryName, fi.Length, fi.LastWriteTimeUtc));
}
});
}
}
, token);
await Task.Yield();
tokenSource.Cancel();
try {
await t;
Console.WriteLine("Retrieved information for {0} files.", files.Count);
}
catch (AggregateException e) {
Console.WriteLine("Exception messages:");
foreach (var ie in e.InnerExceptions)
Console.WriteLine(" {0}: {1}", ie.GetType().Name, ie.Message);
Console.WriteLine("\nTask status: {0}", t.Status);
}
finally {
tokenSource.Dispose();
}
}
}
// The example displays the following output:
// Exception messages:
// TaskCanceledException: A task was canceled.
// TaskCanceledException: A task was canceled.
// ...
//
// Task status: Canceled
open System
open System.IO
open System.Threading
open System.Threading.Tasks
let main =
task {
use tokenSource = new CancellationTokenSource()
let token = tokenSource.Token
let files = ResizeArray()
let t =
Task.Run(
(fun () ->
let dir = "C:\\Windows\\System32\\"
let obj = obj ()
if Directory.Exists dir then
Parallel.ForEach(
Directory.GetFiles dir,
(fun f ->
if token.IsCancellationRequested then
token.ThrowIfCancellationRequested()
let fi = FileInfo f
lock obj (fun () -> files.Add(fi.Name, fi.DirectoryName, fi.Length, fi.LastWriteTimeUtc)))
)
|> ignore),
token
)
do! Task.Yield()
tokenSource.Cancel()
try
do! t
printfn $"Retrieved information for {files.Count} files."
with :? AggregateException as e ->
printfn "Exception messages:"
for ie in e.InnerExceptions do
printfn $" {ie.GetType().Name}: {ie.Message}"
printfn $"Task status: {t.Status}"
}
main.Wait()
// The example displays the following output:
// Exception messages:
// TaskCanceledException: A task was canceled.
// TaskCanceledException: A task was canceled.
// ...
//
// Task status: Canceled
Imports System.Collections.Generic
Imports System.IO
Imports System.Threading
Imports System.Threading.Tasks
Module Example
Public Sub Main()
Dim tokenSource As New CancellationTokenSource()
Dim token As CancellationToken = tokenSource.Token
Dim files As New List(Of Tuple(Of String, String, Long, Date))()
Dim t As Task = Task.Run( Sub()
Dim dir As String = "C:\Windows\System32\"
Dim obj As New Object()
If Directory.Exists(dir)Then
Parallel.ForEach(Directory.GetFiles(dir),
Sub(f)
If token.IsCancellationRequested Then
token.ThrowIfCancellationRequested()
End If
Dim fi As New FileInfo(f)
SyncLock(obj)
files.Add(Tuple.Create(fi.Name, fi.DirectoryName, fi.Length, fi.LastWriteTimeUtc))
End SyncLock
End Sub)
End If
End Sub, token)
tokenSource.Cancel()
Try
t.Wait()
Console.WriteLine("Retrieved information for {0} files.", files.Count)
Catch e As AggregateException
Console.WriteLine("Exception messages:")
For Each ie As Exception In e.InnerExceptions
Console.WriteLine(" {0}:{1}", ie.GetType().Name, ie.Message)
Next
Console.WriteLine()
Console.WriteLine("Task status: {0}", t.Status)
Finally
tokenSource.Dispose()
End Try
End Sub
End Module
' The example displays the following output:
' Exception messages:
' TaskCanceledException: A task was canceled.
'
' Task status: Canceled
Remarques
Si l’annulation est demandée avant le début de l’exécution de la tâche, la tâche ne s’exécute pas. Au lieu de cela, il est défini sur l’état Canceled et lève une TaskCanceledException exception.
La Run(Action, CancellationToken) méthode est une alternative plus simple à la TaskFactory.StartNew(Action, CancellationToken) méthode . Il crée une tâche avec les valeurs par défaut suivantes :
Sa CreationOptions valeur de propriété est TaskCreationOptions.DenyChildAttach.
Il utilise le planificateur de tâches par défaut.
Pour plus d’informations sur la gestion des exceptions levées par des opérations de tâche, consultez Gestion des exceptions.
Voir aussi
S’applique à
Run(Func<Task>, CancellationToken)
Met en file d’attente le travail spécifié à exécuter sur le pool de threads et retourne un proxy pour la tâche retournée par function. Un jeton d’annulation permet l’annulation du travail s’il n’a pas encore été commencé.
public:
static System::Threading::Tasks::Task ^ Run(Func<System::Threading::Tasks::Task ^> ^ function, System::Threading::CancellationToken cancellationToken);public static System.Threading.Tasks.Task Run (Func<System.Threading.Tasks.Task> function, System.Threading.CancellationToken cancellationToken);public static System.Threading.Tasks.Task Run (Func<System.Threading.Tasks.Task?> function, System.Threading.CancellationToken cancellationToken);static member Run : Func<System.Threading.Tasks.Task> * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Shared Function Run (function As Func(Of Task), cancellationToken As CancellationToken) As TaskParamètres
- cancellationToken
- CancellationToken
Un jeton d’annulation peut être utilisé pour annuler le travail s’il n’a pas encore été commencé. Run(Func<Task>, CancellationToken) ne passe pas cancellationToken à action.
Retours
Tâche qui représente un proxy de la tâche retournée par function.
Exceptions
La valeur du paramètre function était null.
La tâche a été annulée.
La CancellationTokenSource associée au cancellationToken a été supprimée.
Remarques
Pour plus d’informations sur la gestion des exceptions levées par des opérations de tâche, consultez Gestion des exceptions.
Voir aussi
S’applique à
Run<TResult>(Func<Task<TResult>>)
Met en file d’attente le travail spécifié à exécuter dans le pool de threads et retourne un proxy pour le Task(TResult) retourné par function. Un jeton d’annulation permet l’annulation du travail s’il n’a pas encore été commencé.
public:
generic <typename TResult>
static System::Threading::Tasks::Task<TResult> ^ Run(Func<System::Threading::Tasks::Task<TResult> ^> ^ function);public static System.Threading.Tasks.Task<TResult> Run<TResult> (Func<System.Threading.Tasks.Task<TResult>> function);public static System.Threading.Tasks.Task<TResult> Run<TResult> (Func<System.Threading.Tasks.Task<TResult>?> function);static member Run : Func<System.Threading.Tasks.Task<'Result>> -> System.Threading.Tasks.Task<'Result>Public Shared Function Run(Of TResult) (function As Func(Of Task(Of TResult))) As Task(Of TResult)Paramètres de type
- TResult
Type du résultat retourné par la tâche de proxy.
Paramètres
Retours
Task(TResult) qui représente un proxy de la Task(TResult) retournée par function.
Exceptions
La valeur du paramètre function était null.
Remarques
Pour plus d’informations sur la gestion des exceptions levées par des opérations de tâche, consultez Gestion des exceptions.
Voir aussi
S’applique à
Run<TResult>(Func<TResult>)
Met en file d'attente le travail spécifié à exécuter dans le pool de threads et retourne un objet Task<TResult> qui représente ce travail. Un jeton d’annulation permet l’annulation du travail s’il n’a pas encore été commencé.
public:
generic <typename TResult>
static System::Threading::Tasks::Task<TResult> ^ Run(Func<TResult> ^ function);public static System.Threading.Tasks.Task<TResult> Run<TResult> (Func<TResult> function);static member Run : Func<'Result> -> System.Threading.Tasks.Task<'Result>Public Shared Function Run(Of TResult) (function As Func(Of TResult)) As Task(Of TResult)Paramètres de type
- TResult
Type de retour de la tâche.
Paramètres
- function
- Func<TResult>
Travail à exécuter de façon asynchrone.
Retours
Objet de tâche qui représente le travail mis en file d'attente à exécuter dans le pool de threads.
Exceptions
Le paramètre function a la valeur null.
Exemples
L’exemple suivant compte le nombre approximatif de mots dans les fichiers texte qui représentent des livres publiés. Chaque tâche est responsable de l’ouverture d’un fichier, de la lecture de son contenu entier de manière asynchrone et du calcul du nombre de mots à l’aide d’une expression régulière. La WaitAll(Task[]) méthode est appelée pour s’assurer que toutes les tâches sont terminées avant d’afficher le nombre de mots de chaque livre dans la console.
using System;
using System.IO;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
public class Example
{
public static void Main()
{
string pattern = @"\p{P}*\s+";
string[] titles = { "Sister Carrie", "The Financier" };
Task<int>[] tasks = new Task<int>[titles.Length];
for (int ctr = 0; ctr < titles.Length; ctr++) {
string s = titles[ctr];
tasks[ctr] = Task.Run( () => {
// Number of words.
int nWords = 0;
// Create filename from title.
string fn = s + ".txt";
if (File.Exists(fn)) {
StreamReader sr = new StreamReader(fn);
string input = sr.ReadToEndAsync().Result;
nWords = Regex.Matches(input, pattern).Count;
}
return nWords;
} );
}
Task.WaitAll(tasks);
Console.WriteLine("Word Counts:\n");
for (int ctr = 0; ctr < titles.Length; ctr++)
Console.WriteLine("{0}: {1,10:N0} words", titles[ctr], tasks[ctr].Result);
}
}
// The example displays the following output:
// Sister Carrie: 159,374 words
// The Financier: 196,362 words
open System
open System.IO
open System.Text.RegularExpressions
open System.Threading.Tasks
let pattern = @"\p{P}*\s+"
let titles = [| "Sister Carrie"; "The Financier" |]
let tasks =
Array.map (fun title ->
Task.Run(fun () ->
// Create filename from title.
let fn = title + ".txt"
if File.Exists fn then
use sr = new StreamReader(fn)
let input = sr.ReadToEndAsync().Result
Regex.Matches(input, pattern).Count
else
0)) titles
tasks |> Seq.cast |> Array.ofSeq |> Task.WaitAll
printfn "Word Counts:\n"
for i = 0 to tasks.Length - 1 do
printfn $"%s{titles.[i]}: %10d{tasks.[i].Result} words"
// The example displays the following output:
// Sister Carrie: 159,374 words
// The Financier: 196,362 words
Imports System.IO
Imports System.Text.RegularExpressions
Imports System.Threading.Tasks
Module Example
Public Sub Main()
Dim pattern As String = "\p{P}*\s+"
Dim titles() As String = { "Sister Carrie",
"The Financier" }
Dim tasks(titles.Length - 1) As Task(Of Integer)
For ctr As Integer = 0 To titles.Length - 1
Dim s As String = titles(ctr)
tasks(ctr) = Task.Run( Function()
' Number of words.
Dim nWords As Integer = 0
' Create filename from title.
Dim fn As String = s + ".txt"
If File.Exists(fn) Then
Dim sr As New StreamReader(fn)
Dim input As String = sr.ReadToEndAsync().Result
nWords = Regex.Matches(input, pattern).Count
End If
Return nWords
End Function)
Next
Task.WaitAll(tasks)
Console.WriteLine("Word Counts:")
Console.WriteLine()
For ctr As Integer = 0 To titles.Length - 1
Console.WriteLine("{0}: {1,10:N0} words", titles(ctr), tasks(ctr).Result)
Next
End Sub
End Module
' The example displays the following output:
' Sister Carrie: 159,374 words
' The Financier: 196,362 words
L’expression \p{P}*\s+ régulière correspond à zéro, un ou plusieurs caractères de ponctuation suivis d’un ou plusieurs espaces blancs. Il suppose que le nombre total de correspondances est égal au nombre approximatif de mots.
Remarques
La Run méthode est une alternative plus simple à la TaskFactory.StartNew(Action) méthode. Il crée une tâche avec les valeurs par défaut suivantes :
Son jeton d’annulation est CancellationToken.None.
Sa CreationOptions valeur de propriété est TaskCreationOptions.DenyChildAttach.
Il utilise le planificateur de tâches par défaut.
Pour plus d’informations sur la gestion des exceptions levées par les opérations de tâche, consultez Gestion des exceptions.
Voir aussi
S’applique à
Run<TResult>(Func<Task<TResult>>, CancellationToken)
Met en file d’attente le travail spécifié à exécuter dans le pool de threads et retourne un proxy pour le Task(TResult) retourné par function.
public:
generic <typename TResult>
static System::Threading::Tasks::Task<TResult> ^ Run(Func<System::Threading::Tasks::Task<TResult> ^> ^ function, System::Threading::CancellationToken cancellationToken);public static System.Threading.Tasks.Task<TResult> Run<TResult> (Func<System.Threading.Tasks.Task<TResult>> function, System.Threading.CancellationToken cancellationToken);public static System.Threading.Tasks.Task<TResult> Run<TResult> (Func<System.Threading.Tasks.Task<TResult>?> function, System.Threading.CancellationToken cancellationToken);static member Run : Func<System.Threading.Tasks.Task<'Result>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Result>Public Shared Function Run(Of TResult) (function As Func(Of Task(Of TResult)), cancellationToken As CancellationToken) As Task(Of TResult)Paramètres de type
- TResult
Type du résultat retourné par la tâche de proxy.
Paramètres
- cancellationToken
- CancellationToken
Un jeton d’annulation peut être utilisé pour annuler le travail s’il n’a pas encore été commencé. Run<TResult>(Func<Task<TResult>>, CancellationToken) ne passe pas cancellationToken à action.
Retours
Task(TResult) qui représente un proxy de la Task(TResult) retournée par function.
Exceptions
La valeur du paramètre function était null.
La tâche a été annulée.
La CancellationTokenSource associée au cancellationToken a été supprimée.
Remarques
Pour plus d’informations sur la gestion des exceptions levées par les opérations de tâche, consultez Gestion des exceptions.
Voir aussi
S’applique à
Run<TResult>(Func<TResult>, CancellationToken)
Met en file d'attente le travail spécifié à exécuter dans le pool de threads et retourne un objet Task(TResult) qui représente ce travail.
public:
generic <typename TResult>
static System::Threading::Tasks::Task<TResult> ^ Run(Func<TResult> ^ function, System::Threading::CancellationToken cancellationToken);public static System.Threading.Tasks.Task<TResult> Run<TResult> (Func<TResult> function, System.Threading.CancellationToken cancellationToken);static member Run : Func<'Result> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Result>Public Shared Function Run(Of TResult) (function As Func(Of TResult), cancellationToken As CancellationToken) As Task(Of TResult)Paramètres de type
- TResult
Type de résultat de la tâche.
Paramètres
- function
- Func<TResult>
Travail à exécuter de façon asynchrone.
- cancellationToken
- CancellationToken
Un jeton d’annulation peut être utilisé pour annuler le travail s’il n’a pas encore été commencé. Run<TResult>(Func<TResult>, CancellationToken) ne passe pas cancellationToken à action.
Retours
Task(TResult) qui représente le travail mis en file d’attente à exécuter dans le pool de threads.
Exceptions
Le paramètre function a la valeur null.
La tâche a été annulée.
La CancellationTokenSource associée au cancellationToken a été supprimée.
Exemples
L’exemple suivant crée 20 tâches qui vont boucler jusqu’à ce qu’un compteur soit incrémenté à une valeur de 2 millions. Lorsque les 10 premières tâches atteignent 2 millions, le jeton d’annulation est annulé et toutes les tâches dont les compteurs n’ont pas atteint 2 millions sont annulées. L’exemple montre une sortie possible.
using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
public class Example
{
public static void Main()
{
var tasks = new List<Task<int>>();
var source = new CancellationTokenSource();
var token = source.Token;
int completedIterations = 0;
for (int n = 0; n <= 19; n++)
tasks.Add(Task.Run( () => { int iterations = 0;
for (int ctr = 1; ctr <= 2000000; ctr++) {
token.ThrowIfCancellationRequested();
iterations++;
}
Interlocked.Increment(ref completedIterations);
if (completedIterations >= 10)
source.Cancel();
return iterations; }, token));
Console.WriteLine("Waiting for the first 10 tasks to complete...\n");
try {
Task.WaitAll(tasks.ToArray());
}
catch (AggregateException) {
Console.WriteLine("Status of tasks:\n");
Console.WriteLine("{0,10} {1,20} {2,14:N0}", "Task Id",
"Status", "Iterations");
foreach (var t in tasks)
Console.WriteLine("{0,10} {1,20} {2,14}",
t.Id, t.Status,
t.Status != TaskStatus.Canceled ? t.Result.ToString("N0") : "n/a");
}
}
}
// The example displays output like the following:
// Waiting for the first 10 tasks to complete...
// Status of tasks:
//
// Task Id Status Iterations
// 1 RanToCompletion 2,000,000
// 2 RanToCompletion 2,000,000
// 3 RanToCompletion 2,000,000
// 4 RanToCompletion 2,000,000
// 5 RanToCompletion 2,000,000
// 6 RanToCompletion 2,000,000
// 7 RanToCompletion 2,000,000
// 8 RanToCompletion 2,000,000
// 9 RanToCompletion 2,000,000
// 10 Canceled n/a
// 11 Canceled n/a
// 12 Canceled n/a
// 13 Canceled n/a
// 14 Canceled n/a
// 15 Canceled n/a
// 16 RanToCompletion 2,000,000
// 17 Canceled n/a
// 18 Canceled n/a
// 19 Canceled n/a
// 20 Canceled n/a
open System
open System.Collections.Generic
open System.Threading
open System.Threading.Tasks
let source = new CancellationTokenSource()
let token = source.Token
let mutable completedIterations = 0
let tasks =
[| for _ = 0 to 19 do
Task.Run(
(fun () ->
let mutable iterations = 0
for _ = 1 to 2000000 do
token.ThrowIfCancellationRequested()
iterations <- iterations + 1
Interlocked.Increment &completedIterations |> ignore
if completedIterations >= 10 then
source.Cancel()
iterations),
token
)
|]
printfn "Waiting for the first 10 tasks to complete...\n"
try
tasks |> Seq.cast |> Array.ofSeq |> Task.WaitAll
with :? AggregateException ->
printfn "Status of tasks:\n"
printfn "%10s %20s %14s" "Task Id" "Status" "Iterations"
for t in tasks do
if t.Status <> TaskStatus.Canceled then
t.Result.ToString "N0"
else
"n/a"
|> printfn "%10i %20O %14s" t.Id t.Status
// The example displays output like the following:
// Waiting for the first 10 tasks to complete...
// Status of tasks:
//
// Task Id Status Iterations
// 1 RanToCompletion 2,000,000
// 2 RanToCompletion 2,000,000
// 3 RanToCompletion 2,000,000
// 4 RanToCompletion 2,000,000
// 5 RanToCompletion 2,000,000
// 6 RanToCompletion 2,000,000
// 7 RanToCompletion 2,000,000
// 8 RanToCompletion 2,000,000
// 9 RanToCompletion 2,000,000
// 10 Canceled n/a
// 11 Canceled n/a
// 12 Canceled n/a
// 13 Canceled n/a
// 14 Canceled n/a
// 15 Canceled n/a
// 16 RanToCompletion 2,000,000
// 17 Canceled n/a
// 18 Canceled n/a
// 19 Canceled n/a
// 20 Canceled n/a
Imports System.Collections.Generic
Imports System.Threading
Imports System.Threading.Tasks
Module Example
Public Sub Main()
Dim tasks As New List(Of Task(Of Integer))()
Dim source As New CancellationTokenSource
Dim token As CancellationToken = source.Token
Dim completedIterations As Integer = 0
For n As Integer = 0 To 19
tasks.Add(Task.Run( Function()
Dim iterations As Integer= 0
For ctr As Long = 1 To 2000000
token.ThrowIfCancellationRequested()
iterations += 1
Next
Interlocked.Increment(completedIterations)
If completedIterations >= 10 Then source.Cancel()
Return iterations
End Function, token))
Next
Console.WriteLine("Waiting for the first 10 tasks to complete... ")
Try
Task.WaitAll(tasks.ToArray())
Catch e As AggregateException
Console.WriteLine("Status of tasks:")
Console.WriteLine()
Console.WriteLine("{0,10} {1,20} {2,14}", "Task Id",
"Status", "Iterations")
For Each t In tasks
Console.WriteLine("{0,10} {1,20} {2,14}",
t.Id, t.Status,
If(t.Status <> TaskStatus.Canceled,
t.Result.ToString("N0"), "n/a"))
Next
End Try
End Sub
End Module
' The example displays output like the following:
' Waiting for the first 10 tasks to complete...
' Status of tasks:
'
' Task Id Status Iterations
' 1 RanToCompletion 2,000,000
' 2 RanToCompletion 2,000,000
' 3 RanToCompletion 2,000,000
' 4 RanToCompletion 2,000,000
' 5 RanToCompletion 2,000,000
' 6 RanToCompletion 2,000,000
' 7 RanToCompletion 2,000,000
' 8 RanToCompletion 2,000,000
' 9 RanToCompletion 2,000,000
' 10 Canceled n/a
' 11 Canceled n/a
' 12 Canceled n/a
' 13 Canceled n/a
' 14 Canceled n/a
' 15 Canceled n/a
' 16 RanToCompletion 2,000,000
' 17 Canceled n/a
' 18 Canceled n/a
' 19 Canceled n/a
' 20 Canceled n/a
Au lieu d’utiliser la InnerExceptions propriété pour examiner les exceptions, l’exemple itère toutes les tâches pour déterminer celles qui se sont terminées avec succès et celles qui ont été annulées. Pour ceux qui se sont terminés, il affiche la valeur retournée par la tâche.
Étant donné que l’annulation est coopérative, chaque tâche peut décider comment répondre à l’annulation. L’exemple suivant est semblable au premier, sauf qu’une fois le jeton annulé, les tâches retournent le nombre d’itérations qu’elles ont effectuées au lieu de lever une exception.
using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
public class Example
{
public static void Main()
{
var tasks = new List<Task<int>>();
var source = new CancellationTokenSource();
var token = source.Token;
int completedIterations = 0;
for (int n = 0; n <= 19; n++)
tasks.Add(Task.Run( () => { int iterations = 0;
for (int ctr = 1; ctr <= 2000000; ctr++) {
if (token.IsCancellationRequested)
return iterations;
iterations++;
}
Interlocked.Increment(ref completedIterations);
if (completedIterations >= 10)
source.Cancel();
return iterations; }, token));
Console.WriteLine("Waiting for the first 10 tasks to complete...\n");
try {
Task.WaitAll(tasks.ToArray());
}
catch (AggregateException) {
Console.WriteLine("Status of tasks:\n");
Console.WriteLine("{0,10} {1,20} {2,14:N0}", "Task Id",
"Status", "Iterations");
foreach (var t in tasks)
Console.WriteLine("{0,10} {1,20} {2,14}",
t.Id, t.Status,
t.Status != TaskStatus.Canceled ? t.Result.ToString("N0") : "n/a");
}
}
}
// The example displays output like the following:
// Status of tasks:
//
// Task Id Status Iterations
// 1 RanToCompletion 2,000,000
// 2 RanToCompletion 2,000,000
// 3 RanToCompletion 2,000,000
// 4 RanToCompletion 2,000,000
// 5 RanToCompletion 2,000,000
// 6 RanToCompletion 2,000,000
// 7 RanToCompletion 2,000,000
// 8 RanToCompletion 2,000,000
// 9 RanToCompletion 2,000,000
// 10 RanToCompletion 1,658,326
// 11 RanToCompletion 1,988,506
// 12 RanToCompletion 2,000,000
// 13 RanToCompletion 1,942,246
// 14 RanToCompletion 950,108
// 15 RanToCompletion 1,837,832
// 16 RanToCompletion 1,687,182
// 17 RanToCompletion 194,548
// 18 Canceled Not Started
// 19 Canceled Not Started
// 20 Canceled Not Started
open System
open System.Collections.Generic
open System.Threading
open System.Threading.Tasks
let source = new CancellationTokenSource()
let token = source.Token
let mutable completedIterations = 0
let tasks =
[| for _ = 0 to 19 do
Task.Run(
(fun () ->
let mutable iterations = 0
for _ = 1 to 2000000 do
token.ThrowIfCancellationRequested()
iterations <- iterations + 1
Interlocked.Increment &completedIterations |> ignore
if completedIterations >= 10 then
source.Cancel()
iterations),
token
) |]
printfn "Waiting for the first 10 tasks to complete...\n"
try
tasks |> Seq.cast |> Array.ofSeq |> Task.WaitAll
with :? AggregateException ->
printfn "Status of tasks:\n"
printfn "%10s %20s %14s" "Task Id" "Status" "Iterations"
for t in tasks do
if t.Status <> TaskStatus.Canceled then
t.Result.ToString "N0"
else
"n/a"
|> printfn "%10i %20O %14s" t.Id t.Status
// The example displays output like the following:
// Status of tasks:
//
// Task Id Status Iterations
// 1 RanToCompletion 2,000,000
// 2 RanToCompletion 2,000,000
// 3 RanToCompletion 2,000,000
// 4 RanToCompletion 2,000,000
// 5 RanToCompletion 2,000,000
// 6 RanToCompletion 2,000,000
// 7 RanToCompletion 2,000,000
// 8 RanToCompletion 2,000,000
// 9 RanToCompletion 2,000,000
// 10 RanToCompletion 1,658,326
// 11 RanToCompletion 1,988,506
// 12 RanToCompletion 2,000,000
// 13 RanToCompletion 1,942,246
// 14 RanToCompletion 950,108
// 15 RanToCompletion 1,837,832
// 16 RanToCompletion 1,687,182
// 17 RanToCompletion 194,548
// 18 Canceled Not Started
// 19 Canceled Not Started
// 20 Canceled Not Started
Imports System.Collections.Generic
Imports System.Threading
Imports System.Threading.Tasks
Module Example
Public Sub Main()
Dim tasks As New List(Of Task(Of Integer))()
Dim source As New CancellationTokenSource
Dim token As CancellationToken = source.Token
Dim completedIterations As Integer = 0
For n As Integer = 0 To 19
tasks.Add(Task.Run( Function()
Dim iterations As Integer= 0
For ctr As Long = 1 To 2000000
If token.IsCancellationRequested Then
Return iterations
End If
iterations += 1
Next
Interlocked.Increment(completedIterations)
If completedIterations >= 10 Then source.Cancel()
Return iterations
End Function, token))
Next
Try
Task.WaitAll(tasks.ToArray())
Catch e As AggregateException
Console.WriteLine("Status of tasks:")
Console.WriteLine()
Console.WriteLine("{0,10} {1,20} {2,14:N0}", "Task Id",
"Status", "Iterations")
For Each t In tasks
Console.WriteLine("{0,10} {1,20} {2,14}",
t.Id, t.Status,
If(t.Status <> TaskStatus.Canceled,
t.Result.ToString("N0"), "Not Started"))
Next
End Try
End Sub
End Module
' The example displays output like the following:
' Status of tasks:
'
' Task Id Status Iterations
' 1 RanToCompletion 2,000,000
' 2 RanToCompletion 2,000,000
' 3 RanToCompletion 2,000,000
' 4 RanToCompletion 2,000,000
' 5 RanToCompletion 2,000,000
' 6 RanToCompletion 2,000,000
' 7 RanToCompletion 2,000,000
' 8 RanToCompletion 2,000,000
' 9 RanToCompletion 2,000,000
' 10 RanToCompletion 1,658,326
' 11 RanToCompletion 1,988,506
' 12 RanToCompletion 2,000,000
' 13 RanToCompletion 1,942,246
' 14 RanToCompletion 950,108
' 15 RanToCompletion 1,837,832
' 16 RanToCompletion 1,687,182
' 17 RanToCompletion 194,548
' 18 Canceled Not Started
' 19 Canceled Not Started
' 20 Canceled Not Started
L’exemple doit toujours gérer l’exception, car toutes les AggregateException tâches qui n’ont pas démarré lors de la demande d’annulation lèvent toujours une exception.
Remarques
Si l’annulation est demandée avant le début de l’exécution de la tâche, la tâche ne s’exécute pas. Au lieu de cela, il est défini sur l’état Canceled et lève une TaskCanceledException exception.
La Run méthode est une alternative plus simple à la StartNew méthode. Il crée une tâche avec les valeurs par défaut suivantes :
Sa CreationOptions valeur de propriété est TaskCreationOptions.DenyChildAttach.
Il utilise le planificateur de tâches par défaut.
Pour plus d’informations sur la gestion des exceptions levées par les opérations de tâche, consultez Gestion des exceptions.
Voir aussi
S’applique à
Commentaires
Envoyer et afficher des commentaires pour