TaskCompletionSource<TResult> Kelas

Definisi

Ruang nama:

System.Threading.Tasks

Rakitan:

System.Runtime.dll

Sumber:

TaskCompletionSource_T.cs

Mewakili sisi produsen dari Task<TResult> tidak terikat ke delegasi, menyediakan akses ke sisi konsumen melalui properti Task.

generic <typename TResult>
public ref class TaskCompletionSource

public class TaskCompletionSource<TResult>

type TaskCompletionSource<'Result> = class

Public Class TaskCompletionSource(Of TResult)

Jenis parameter

TResult

Jenis nilai hasil yang terkait dengan TaskCompletionSource<TResult>ini .

Warisan

Object

TaskCompletionSource<TResult>

Contoh

Contoh berikut menunjukkan cara menggunakan 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

Keterangan

Dalam banyak skenario, berguna untuk mengaktifkan Task<TResult> untuk mewakili operasi asinkron eksternal. TaskCompletionSource<TResult> disediakan untuk tujuan ini. Ini memungkinkan pembuatan tugas yang dapat diserahkan kepada konsumen. Konsumen dapat menggunakan anggota tugas dengan cara yang sama seperti yang mereka lakukan dalam skenario lain yang menangani variabel anggota tugas. Namun, tidak seperti kebanyakan tugas, status tugas yang dibuat oleh TaskCompletionSource dikontrol secara eksplisit oleh metode pada TaskCompletionSource. Ini memungkinkan penyelesaian operasi asinkron eksternal untuk disebarkan ke Tugas yang mendasar. Pemisahan ini juga memastikan bahwa konsumen tidak dapat melakukan transisi status tanpa akses ke TaskCompletionSource yang sesuai. Untuk informasi selengkapnya, lihat entri > Nature of TaskCompletionSource<TResult di blog Pemrograman Paralel dengan .NET.

Sampel Ekstensi Paralel juga berisi contoh cara menggunakan TaskCompletionSource<TResult>.

Konstruktor

TaskCompletionSource<TResult>()	Membuat TaskCompletionSource<TResult>.
TaskCompletionSource<TResult>(Object)	Membuat TaskCompletionSource<TResult> dengan status yang ditentukan.
TaskCompletionSource<TResult>(Object, TaskCreationOptions)	Membuat TaskCompletionSource<TResult> dengan status dan opsi yang ditentukan.
TaskCompletionSource<TResult>(TaskCreationOptions)	Membuat TaskCompletionSource<TResult> dengan opsi yang ditentukan.

Properti

Task	Mendapatkan Task<TResult> yang dibuat oleh TaskCompletionSource<TResult>ini.

Metode

Equals(Object)	Menentukan apakah objek yang ditentukan sama dengan objek saat ini. (Diperoleh dari Object)
GetHashCode()	Berfungsi sebagai fungsi hash default. (Diperoleh dari Object)
GetType()	Mendapatkan Type instans saat ini. (Diperoleh dari Object)
MemberwiseClone()	Membuat salinan dangkal dari Objectsaat ini. (Diperoleh dari Object)
SetCanceled()	Transisi Task<TResult> yang mendasar ke status Canceled.
SetCanceled(CancellationToken)	Transisi Task<TResult> yang mendasar ke status Canceled menggunakan token yang ditentukan.
SetException(Exception)	Transisi Task<TResult> yang mendasar ke dalam status Faulted dan mengikatnya ke pengecualian tertentu.
SetException(IEnumerable<Exception>)	Transisi Task<TResult> yang mendasar ke status Faulted dan mengikat kumpulan objek pengecualian ke dalamnya.
SetResult(TResult)	Transisi Task<TResult> yang mendasar ke status RanToCompletion.
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)
TrySetCanceled()	Mencoba untuk mentransisikan Task<TResult> yang mendasar ke status Canceled.
TrySetCanceled(CancellationToken)	Mencoba untuk mentransisikan Task<TResult> yang mendasar ke status Canceled dan memungkinkan token pembatalan disimpan dalam tugas yang dibatalkan.
TrySetException(Exception)	Mencoba untuk mentransisikan Task<TResult> yang mendasar ke status Faulted dan mengikatnya ke pengecualian tertentu.
TrySetException(IEnumerable<Exception>)	Mencoba untuk mentransisikan Task<TResult> yang mendasar ke dalam status Faulted dan mengikat kumpulan objek pengecualian ke dalamnya.
TrySetResult(TResult)	Mencoba untuk mentransisikan Task<TResult> yang mendasar ke status RanToCompletion.

Keamanan Thread

Semua anggota TaskCompletionSource<TResult> aman utas dan dapat digunakan dari beberapa utas secara bersamaan.

Lihat juga

• Menggunakan TPL dengan Pola Asinkron Lainnya
• Cara: Membungkus Pola EAP dalam Tugas