TaskCompletionSource<TResult> クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
デリゲートに関連付けられていない Task<TResult> のプロデューサー側を表し、Task プロパティを通じてコンシューマー側へのアクセスを提供します。
generic <typename TResult>
public ref class TaskCompletionSourcepublic class TaskCompletionSource<TResult>type TaskCompletionSource<'Result> = classPublic Class TaskCompletionSource(Of TResult)型パラメーター
- TResult
これに TaskCompletionSource<TResult>関連付けられている結果値の型。
- 継承
-
TaskCompletionSource<TResult>
例
次の例では、次を使用する方法を TaskCompletionSource<TResult>示します。
using System;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;
class TCSDemo
{
// Demonstrated features:
// TaskCompletionSource ctor()
// TaskCompletionSource.SetResult()
// TaskCompletionSource.SetException()
// Task.Result
// Expected results:
// The attempt to get t1.Result blocks for ~1000ms until tcs1 gets signaled. 15 is printed out.
// The attempt to get t2.Result blocks for ~1000ms until tcs2 gets signaled. An exception is printed out.
static void Main()
{
TaskCompletionSource<int> tcs1 = new TaskCompletionSource<int>();
Task<int> t1 = tcs1.Task;
// Start a background task that will complete tcs1.Task
Task.Factory.StartNew(() =>
{
Thread.Sleep(1000);
tcs1.SetResult(15);
});
// The attempt to get the result of t1 blocks the current thread until the completion source gets signaled.
// It should be a wait of ~1000 ms.
Stopwatch sw = Stopwatch.StartNew();
int result = t1.Result;
sw.Stop();
Console.WriteLine("(ElapsedTime={0}): t1.Result={1} (expected 15) ", sw.ElapsedMilliseconds, result);
// ------------------------------------------------------------------
// Alternatively, an exception can be manually set on a TaskCompletionSource.Task
TaskCompletionSource<int> tcs2 = new TaskCompletionSource<int>();
Task<int> t2 = tcs2.Task;
// Start a background Task that will complete tcs2.Task with an exception
Task.Factory.StartNew(() =>
{
Thread.Sleep(1000);
tcs2.SetException(new InvalidOperationException("SIMULATED EXCEPTION"));
});
// The attempt to get the result of t2 blocks the current thread until the completion source gets signaled with either a result or an exception.
// In either case it should be a wait of ~1000 ms.
sw = Stopwatch.StartNew();
try
{
result = t2.Result;
Console.WriteLine("t2.Result succeeded. THIS WAS NOT EXPECTED.");
}
catch (AggregateException e)
{
Console.Write("(ElapsedTime={0}): ", sw.ElapsedMilliseconds);
Console.WriteLine("The following exceptions have been thrown by t2.Result: (THIS WAS EXPECTED)");
for (int j = 0; j < e.InnerExceptions.Count; j++)
{
Console.WriteLine("\n-------------------------------------------------\n{0}", e.InnerExceptions[j].ToString());
}
}
}
}
Imports System.Diagnostics
Imports System.Threading
Imports System.Threading.Tasks
Module TCSDemo
' Demonstrated features:
' TaskCompletionSource ctor()
' TaskCompletionSource.SetResult()
' TaskCompletionSource.SetException()
' Task.Result
' Expected results:
' The attempt to get t1.Result blocks for ~1000ms until tcs1 gets signaled. 15 is printed out.
' The attempt to get t2.Result blocks for ~1000ms until tcs2 gets signaled. An exception is printed out.
Private Sub Main()
Dim tcs1 As New TaskCompletionSource(Of Integer)()
Dim t1 As Task(Of Integer) = tcs1.Task
' Start a background task that will complete tcs1.Task
Task.Factory.StartNew(Sub()
Thread.Sleep(1000)
tcs1.SetResult(15)
End Sub)
' The attempt to get the result of t1 blocks the current thread until the completion source gets signaled.
' It should be a wait of ~1000 ms.
Dim sw As Stopwatch = Stopwatch.StartNew()
Dim result As Integer = t1.Result
sw.Stop()
Console.WriteLine("(ElapsedTime={0}): t1.Result={1} (expected 15) ", sw.ElapsedMilliseconds, result)
' ------------------------------------------------------------------
' Alternatively, an exception can be manually set on a TaskCompletionSource.Task
Dim tcs2 As New TaskCompletionSource(Of Integer)()
Dim t2 As Task(Of Integer) = tcs2.Task
' Start a background Task that will complete tcs2.Task with an exception
Task.Factory.StartNew(Sub()
Thread.Sleep(1000)
tcs2.SetException(New InvalidOperationException("SIMULATED EXCEPTION"))
End Sub)
' The attempt to get the result of t2 blocks the current thread until the completion source gets signaled with either a result or an exception.
' In either case it should be a wait of ~1000 ms.
sw = Stopwatch.StartNew()
Try
result = t2.Result
Console.WriteLine("t2.Result succeeded. THIS WAS NOT EXPECTED.")
Catch e As AggregateException
Console.Write("(ElapsedTime={0}): ", sw.ElapsedMilliseconds)
Console.WriteLine("The following exceptions have been thrown by t2.Result: (THIS WAS EXPECTED)")
For j As Integer = 0 To e.InnerExceptions.Count - 1
Console.WriteLine(vbLf & "-------------------------------------------------" & vbLf & "{0}", e.InnerExceptions(j).ToString())
Next
End Try
End Sub
End Module
注釈
多くのシナリオでは、外部非同期操作を表すために a Task<TResult> を有効にすると便利です。 TaskCompletionSource<TResult> は、この目的のために提供されます。 これにより、コンシューマーに渡すことができるタスクを作成できます。 コンシューマーは、タスク メンバー変数を処理する他のシナリオと同じように、タスクのメンバーを使用できます。 ただし、ほとんどのタスクとは異なり、TaskCompletionSource によって作成されたタスクの状態は、TaskCompletionSource のメソッドによって明示的に制御されます。 これにより、外部非同期操作の完了を基になるタスクに反映できます。 また、この分離により、コンシューマーは対応する TaskCompletionSource にアクセスせずに状態を移行できなくなります。 詳細については、「.NET による並列プログラミング」の「TaskCompletionSource<TResult> の性質」のエントリを参照してください。
Parallel Extensions のサンプルには、使用方法TaskCompletionSource<TResult>の例も含まれています。
コンストラクター
| TaskCompletionSource<TResult>() |
TaskCompletionSource<TResult> を作成します。 |
| TaskCompletionSource<TResult>(Object) |
指定された状態を使用して、TaskCompletionSource<TResult> を作成します。 |
| TaskCompletionSource<TResult>(Object, TaskCreationOptions) |
指定された状態とオプションを使用して、TaskCompletionSource<TResult> を作成します。 |
| TaskCompletionSource<TResult>(TaskCreationOptions) |
指定されたオプションを使用して、TaskCompletionSource<TResult> を作成します。 |
プロパティ
| Task |
この Task<TResult> によって作成される TaskCompletionSource<TResult> を取得します。 |
メソッド
適用対象
スレッド セーフ
すべてのメンバーはスレッド セーフであり、複数の TaskCompletionSource<TResult> スレッドから同時に使用できます。