Task.Run メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
ThreadPool で実行する指定された作業をキューに入れ、その作業のタスクまたは Task<TResult> ハンドルを返します。
オーバーロード
Run(Func<Task>, CancellationToken) |
スレッド プールで実行する指定された作業をキューに入れ、 |
Run(Action, CancellationToken) |
スレッド プールで実行する指定された作業をキューに入れ、その作業を表す Task オブジェクトを返します。 取り消しトークンを使用すると、まだ開始されていない場合に作業を取り消すことができます。 |
Run(Func<Task>) |
スレッド プールで実行する指定された作業をキューに入れ、 |
Run(Action) |
スレッド プールで実行する指定された作業をキューに入れ、その作業を表す Task オブジェクトを返します。 |
Run<TResult>(Func<Task<TResult>>) |
スレッド プールで実行する指定された作業をキューに入れ、 |
Run<TResult>(Func<TResult>) |
スレッド プールで実行する指定された作業をキューに入れ、その作業を表す Task<TResult> オブジェクトを返します。 取り消しトークンを使用すると、まだ開始されていない場合に作業を取り消すことができます。 |
Run<TResult>(Func<Task<TResult>>, CancellationToken) |
スレッド プールで実行する指定された作業をキューに入れ、 |
Run<TResult>(Func<TResult>, CancellationToken) |
スレッド プールで実行する指定された作業をキューに入れ、その作業を表す |
注釈
Run メソッドは、既定値を使用してタスクを簡単に開始できるようにする一連のオーバーロードを提供します。 これは、StartNew オーバーロードに代わる軽量の代替手段です。
Run(Func<Task>, CancellationToken)
- ソース:
- Task.cs
- ソース:
- Task.cs
- ソース:
- Task.cs
スレッド プールで実行する指定された作業をキューに入れ、function
によって返されるタスクのプロキシを返します。 取り消しトークンを使用すると、まだ開始されていない場合に作業を取り消すことができます。
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.Task
Public Shared Function Run (function As Func(Of Task), cancellationToken As CancellationToken) As Task
パラメーター
- cancellationToken
- CancellationToken
まだ開始されていない場合に作業を取り消すために使用できるキャンセル トークン。
Run(Func<Task>, CancellationToken) は action
に cancellationToken
を渡しません。
戻り値
function
によって返されるタスクのプロキシを表すタスク。
例外
function
パラメーターが null
されました。
タスクが取り消されました。 この例外は、返されたタスクに格納されます。
cancellationToken
に関連付けられている CancellationTokenSource が破棄されました。
タスクが取り消されました。
注釈
タスク操作によってスローされる例外の処理については、「例外処理」を参照してください。
こちらもご覧ください
適用対象
Run(Action, CancellationToken)
- ソース:
- Task.cs
- ソース:
- Task.cs
- ソース:
- Task.cs
スレッド プールで実行する指定された作業をキューに入れ、その作業を表す Task オブジェクトを返します。 取り消しトークンを使用すると、まだ開始されていない場合に作業を取り消すことができます。
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.Task
Public Shared Function Run (action As Action, cancellationToken As CancellationToken) As Task
パラメーター
- action
- Action
非同期的に実行する作業。
- cancellationToken
- CancellationToken
まだ開始されていない場合に作業を取り消すために使用できるキャンセル トークン。
Run(Action, CancellationToken) は action
に cancellationToken
を渡しません。
戻り値
スレッド プールで実行するためにキューに登録された作業を表すタスク。
例外
action
パラメーターが null
されました。
タスクが取り消されました。 この例外は、返されたタスクに格納されます。
cancellationToken
に関連付けられている CancellationTokenSource が破棄されました。
タスクが取り消されました。
例
次の例では、Run(Action, CancellationToken) メソッドを呼び出して、C:\Windows\System32 ディレクトリ内のファイルを反復処理するタスクを作成します。 ラムダ式は、Parallel.ForEach メソッドを呼び出して、各ファイルに関する情報を List<T> オブジェクトに追加します。
Parallel.ForEach ループによって呼び出されたデタッチされた各入れ子になったタスクは、キャンセル トークンの状態をチェックし、取り消しが要求された場合は、CancellationToken.ThrowIfCancellationRequested メソッドを呼び出します。
CancellationToken.ThrowIfCancellationRequested メソッドは、呼び出し元のスレッドが Task.Wait メソッドを呼び出すときに、catch
ブロックで処理される OperationCanceledException 例外をスローします。
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
注釈
タスクの実行が開始される前に取り消しが要求された場合、タスクは実行されません。 代わりに、Canceled 状態に設定され、TaskCanceledException 例外がスローされます。
Run(Action, CancellationToken) メソッドは、TaskFactory.StartNew(Action, CancellationToken) メソッドの代わりに簡単です。 次の既定値を使用してタスクが作成されます。
その CreationOptions プロパティ値は TaskCreationOptions.DenyChildAttachです。
既定のタスク スケジューラを使用します。
タスク操作によってスローされる例外の処理については、「例外処理」を参照してください。
こちらもご覧ください
適用対象
Run(Func<Task>)
- ソース:
- Task.cs
- ソース:
- Task.cs
- ソース:
- Task.cs
スレッド プールで実行する指定された作業をキューに入れ、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.Task
Public Shared Function Run (function As Func(Of Task)) As Task
パラメーター
戻り値
function
によって返されるタスクのプロキシを表すタスク。
例外
function
パラメーターが null
されました。
注釈
タスク操作によってスローされる例外の処理については、「例外処理」を参照してください。
こちらもご覧ください
適用対象
Run(Action)
- ソース:
- Task.cs
- ソース:
- Task.cs
- ソース:
- Task.cs
スレッド プールで実行する指定された作業をキューに入れ、その作業を表す Task オブジェクトを返します。
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.Task
Public Shared Function Run (action As Action) As Task
パラメーター
- action
- Action
非同期的に実行する作業。
戻り値
ThreadPool で実行するためにキューに登録された作業を表すタスク。
例外
action
パラメーターが null
されました。
例
次の例では、現在のスレッドの Thread.ManagedThreadId を表示する ShowThreadInfo
メソッドを定義します。 アプリケーション スレッドから直接呼び出され、Run(Action) メソッドに渡された Action デリゲートから呼び出されます。
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
次の例は前の例と似ていますが、ラムダ式を使用してタスクを実行するコードを定義する点が異なります。
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
この例は、非同期タスクがメイン アプリケーション スレッドとは異なるスレッドで実行されることを示しています。
Wait メソッドを呼び出すと、タスクが完了し、アプリケーションが終了する前にその出力が表示されます。 それ以外の場合は、タスクが完了する前に Main
メソッドが完了する可能性があります。
次の例は、Run(Action) メソッドを示しています。 ディレクトリ名の配列を定義し、各ディレクトリ内のファイル名を取得する個別のタスクを開始します。 すべてのタスクは、ファイル名を 1 つの ConcurrentBag<T> オブジェクトに書き込みます。 次に、WaitAll(Task[]) メソッドを呼び出して、すべてのタスクが完了したことを確認し、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
注釈
Run メソッドを使用すると、1 回のメソッド呼び出しでタスクを作成して実行することができ、StartNew メソッドに代わる簡単な方法です。 次の既定値を使用してタスクが作成されます。
そのキャンセル トークンは CancellationToken.Noneです。
その CreationOptions プロパティ値は TaskCreationOptions.DenyChildAttachです。
既定のタスク スケジューラを使用します。
タスク操作によってスローされる例外の処理については、「例外処理」を参照してください。
こちらもご覧ください
適用対象
Run<TResult>(Func<Task<TResult>>)
- ソース:
- Task.cs
- ソース:
- Task.cs
- ソース:
- Task.cs
スレッド プールで実行する指定された作業をキューに入れ、function
によって返される Task(TResult)
のプロキシを返します。 取り消しトークンを使用すると、まだ開始されていない場合に作業を取り消すことができます。
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)
型パラメーター
- TResult
プロキシ タスクによって返される結果の型。
パラメーター
戻り値
function
によって返される Task(TResult)
のプロキシを表す Task(TResult)
。
例外
function
パラメーターが null
されました。
注釈
タスク操作によってスローされる例外の処理については、「例外処理」を参照してください。
こちらもご覧ください
適用対象
Run<TResult>(Func<TResult>)
- ソース:
- Task.cs
- ソース:
- Task.cs
- ソース:
- Task.cs
スレッド プールで実行する指定された作業をキューに入れ、その作業を表す Task<TResult> オブジェクトを返します。 取り消しトークンを使用すると、まだ開始されていない場合に作業を取り消すことができます。
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)
型パラメーター
- TResult
タスクの戻り値の型。
パラメーター
- function
- Func<TResult>
非同期的に実行する作業。
戻り値
スレッド プールで実行するためにキューに登録された作業を表すタスク オブジェクト。
例外
function
パラメーターは null
です。
例
次の例では、発行された書籍を表すテキスト ファイル内の単語の概数をカウントします。 各タスクは、ファイルを開き、その内容全体を非同期的に読み取り、正規表現を使用して単語数を計算する役割を担います。 WaitAll(Task[]) メソッドが呼び出され、各書籍のワード カウントをコンソールに表示する前にすべてのタスクが完了していることを確認します。
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
正規表現 \p{P}*\s+
は、0 文字、1 つ以上の句読点文字の後に 1 つ以上の空白文字が続きます。 一致の合計数がおおよそのワード カウントと等しいことを前提としています。
注釈
Run メソッドは、TaskFactory.StartNew(Action) メソッドの代わりに簡単です。 次の既定値を使用してタスクが作成されます。
そのキャンセル トークンは CancellationToken.Noneです。
その CreationOptions プロパティ値は TaskCreationOptions.DenyChildAttachです。
既定のタスク スケジューラを使用します。
タスク操作によってスローされる例外の処理については、「例外処理」を参照してください。
こちらもご覧ください
適用対象
Run<TResult>(Func<Task<TResult>>, CancellationToken)
- ソース:
- Task.cs
- ソース:
- Task.cs
- ソース:
- Task.cs
スレッド プールで実行する指定された作業をキューに入れ、function
によって返される Task(TResult)
のプロキシを返します。
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)
型パラメーター
- TResult
プロキシ タスクによって返される結果の型。
パラメーター
- cancellationToken
- CancellationToken
まだ開始されていない場合に作業を取り消すために使用できるキャンセル トークン。
Run<TResult>(Func<Task<TResult>>, CancellationToken) は action
に cancellationToken
を渡しません。
戻り値
function
によって返される Task(TResult)
のプロキシを表す Task(TResult)
。
例外
function
パラメーターが null
されました。
タスクが取り消されました。 この例外は、返されたタスクに格納されます。
cancellationToken
に関連付けられている CancellationTokenSource が破棄されました。
タスクが取り消されました。
注釈
タスク操作によってスローされる例外の処理については、「例外処理」を参照してください。
こちらもご覧ください
適用対象
Run<TResult>(Func<TResult>, CancellationToken)
- ソース:
- Task.cs
- ソース:
- Task.cs
- ソース:
- Task.cs
スレッド プールで実行する指定された作業をキューに入れ、その作業を表す Task(TResult)
オブジェクトを返します。
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)
型パラメーター
- TResult
タスクの結果の種類。
パラメーター
- function
- Func<TResult>
非同期的に実行する作業。
- cancellationToken
- CancellationToken
まだ開始されていない場合に作業を取り消すために使用できるキャンセル トークン。
Run<TResult>(Func<TResult>, CancellationToken) は action
に cancellationToken
を渡しません。
戻り値
スレッド プールで実行するためにキューに登録された作業を表す Task(TResult)
。
例外
function
パラメーターは null
です。
タスクが取り消されました。 この例外は、返されたタスクに格納されます。
cancellationToken
に関連付けられている CancellationTokenSource が破棄されました。
タスクが取り消されました。
例
次の例では、カウンターが 200 万の値にインクリメントされるまでループする 20 個のタスクを作成します。 最初の 10 個のタスクが 200 万に達すると、キャンセル トークンが取り消され、カウンターが 200 万に達していないタスクはすべて取り消されます。 この例は、出力の可能性を示しています。
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
この例では、InnerExceptions プロパティを使用して例外を調べる代わりに、すべてのタスクを反復処理して、正常に完了したタスクと取り消されたタスクを特定します。 完了した場合は、タスクによって返された値が表示されます。
取り消しは協調的であるため、各タスクは取り消しに対応する方法を決定できます。 次の例は最初の例のようになりますが、トークンが取り消されると、タスクは例外をスローするのではなく、完了したイテレーションの数を返します。
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
取り消しが要求されたときに開始されていないタスクは例外をスローするため、この例では引き続き AggregateException 例外を処理する必要があります。
注釈
タスクの実行が開始される前に取り消しが要求された場合、タスクは実行されません。 代わりに、Canceled 状態に設定され、TaskCanceledException 例外がスローされます。
Run メソッドは、StartNew メソッドの代わりに簡単です。 次の既定値を使用してタスクが作成されます。
その CreationOptions プロパティ値は TaskCreationOptions.DenyChildAttachです。
既定のタスク スケジューラを使用します。
タスク操作によってスローされる例外の処理については、「例外処理」を参照してください。
こちらもご覧ください
適用対象
.NET