TaskCompletionSource<TResult> Klasa

Definicja

Reprezentuje stronę producenta Task<TResult> niepowiązana z delegatem, zapewniając dostęp do klienta za pomocą właściwości Task.Represents the producer side of a Task<TResult> unbound to a delegate, providing access to the consumer side through the Task property.

generic <typename TResult>
public ref class TaskCompletionSource
public class TaskCompletionSource<TResult>
type TaskCompletionSource<'Result> = class
Public Class TaskCompletionSource(Of TResult)

Parametry typu

TResult

Typ wartości wyniku skojarzonej z tym TaskCompletionSource<TResult>.The type of the result value associated with this TaskCompletionSource<TResult>.

Dziedziczenie
TaskCompletionSource<TResult>

Przykłady

Poniższy przykład pokazuje, jak używać TaskCompletionSource<TResult>:The following example shows how to use a 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

Uwagi

W wielu scenariuszach warto włączyć Task<TResult> do reprezentowania zewnętrznej operacji asynchronicznej.In many scenarios, it is useful to enable a Task<TResult> to represent an external asynchronous operation. TaskCompletionSource<TResult> do tego celu.TaskCompletionSource<TResult> is provided for this purpose. Umożliwia tworzenie zadań, które mogą być przekazywane do klientów.It enables the creation of a task that can be handed out to consumers. Odbiorcy mogą używać elementów członkowskich zadania w taki sam sposób jak w przypadku innych zmiennych składowych zadania obsługi scenariuszy.The consumers can use the members of the task the same way as they would in any other scenario handling task member variables. Jednak, w przeciwieństwie do większości zadań, stan zadania utworzonego przez TaskCompletionSource jest kontrolowany jawnie przez metody w TaskCompletionSource.However, unlike most tasks, the state of a task created by a TaskCompletionSource is controlled explicitly by the methods on TaskCompletionSource. Umożliwia to ukończenie zewnętrznej operacji asynchronicznej do propagowania do zadania bazowego.This enables the completion of the external asynchronous operation to be propagated to the underlying Task. Oddzielenie gwarantuje także, że konsumenci nie mogą przejść do stanu bez dostępu do odpowiednich TaskCompletionSource.The separation also ensures that consumers are not able to transition the state without access to the corresponding TaskCompletionSource. Aby uzyskać więcej informacji, zapoznaj się z wpisem natura TaskCompletionSource<TResult > w blogu programowanie równoległe przy użyciu platformy .NET.For more information, see the entry The Nature of TaskCompletionSource<TResult> in the Parallel Programming with .NET blog.

Przykłady rozszerzeń równoległych zawierają również przykłady użycia TaskCompletionSource<TResult>.The Parallel Extensions samples also contain examples of how to use TaskCompletionSource<TResult>.

Konstruktory

TaskCompletionSource<TResult>()

Tworzy element TaskCompletionSource<TResult>.Creates a TaskCompletionSource<TResult>.

TaskCompletionSource<TResult>(Object)

Tworzy TaskCompletionSource<TResult> z określonym stanem.Creates a TaskCompletionSource<TResult> with the specified state.

TaskCompletionSource<TResult>(Object, TaskCreationOptions)

Tworzy TaskCompletionSource<TResult> o określonym stanie i opcjach.Creates a TaskCompletionSource<TResult> with the specified state and options.

TaskCompletionSource<TResult>(TaskCreationOptions)

Tworzy TaskCompletionSource<TResult> przy użyciu określonych opcji.Creates a TaskCompletionSource<TResult> with the specified options.

Właściwości

Task

Pobiera Task<TResult> utworzony przez tę TaskCompletionSource<TResult>.Gets the Task<TResult> created by this TaskCompletionSource<TResult>.

Metody

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.Determines whether the specified object is equal to the current object.

(Odziedziczone po Object)
GetHashCode()

Służy jako domyślna funkcja skrótu.Serves as the default hash function.

(Odziedziczone po Object)
GetType()

Pobiera Type bieżącego wystąpienia.Gets the Type of the current instance.

(Odziedziczone po Object)
MemberwiseClone()

Tworzy skróconą kopię bieżącego Object.Creates a shallow copy of the current Object.

(Odziedziczone po Object)
SetCanceled()

Przechodzi do stanu Canceled bazowego Task<TResult>.Transitions the underlying Task<TResult> into the Canceled state.

SetCanceled(CancellationToken)
SetException(Exception)

Przechodzi do stanu Faulted bazowego Task<TResult> i wiąże go z określonym wyjątkiem.Transitions the underlying Task<TResult> into the Faulted state and binds it to a specified exception.

SetException(IEnumerable<Exception>)

Przejście bazowego Task<TResult> do stanu Faulted i powiązanie kolekcji obiektów wyjątków z nim.Transitions the underlying Task<TResult> into the Faulted state and binds a collection of exception objects to it.

SetResult(TResult)

Przechodzi do stanu RanToCompletion bazowego Task<TResult>.Transitions the underlying Task<TResult> into the RanToCompletion state.

ToString()

Zwraca ciąg reprezentujący bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)
TrySetCanceled()

Próbuje przejść bazowe Task<TResult> do stanu Canceled.Attempts to transition the underlying Task<TResult> into the Canceled state.

TrySetCanceled(CancellationToken)

Próbuje przenieść bazowe Task<TResult> do stanu Canceled i umożliwia zapisanie tokenu anulowania w anulowanym zadaniu.Attempts to transition the underlying Task<TResult> into the Canceled state and enables a cancellation token to be stored in the canceled task.

TrySetException(Exception)

Podejmuje próbę przejścia podstawowego Task<TResult> do stanu Faulted i wiąże go z określonym wyjątkem.Attempts to transition the underlying Task<TResult> into the Faulted state and binds it to a specified exception.

TrySetException(IEnumerable<Exception>)

Próbuje przenieść bazowe Task<TResult> do stanu Faulted i tworzy powiązanie kolekcji obiektów wyjątków z nim.Attempts to transition the underlying Task<TResult> into the Faulted state and binds a collection of exception objects to it.

TrySetResult(TResult)

Próbuje przejść bazowe Task<TResult> do stanu RanToCompletion.Attempts to transition the underlying Task<TResult> into the RanToCompletion state.

Dotyczy

Bezpieczeństwo wątkowe

Wszystkie elementy członkowskie TaskCompletionSource<TResult> są bezpieczne dla wątków i mogą być używane jednocześnie z wielu wątków.All members of TaskCompletionSource<TResult> are thread-safe and may be used from multiple threads concurrently.

Zobacz też