Share via

  • Article

TaskFactory<TResult> Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Provides support for creating and scheduling Task<TResult> objects.

Inheritance Hierarchy

System.Object
  System.Threading.Tasks.TaskFactory<TResult>

Namespace:  System.Threading.Tasks
Assembly:  mscorlib (in mscorlib.dll)

Syntax

'Declaration
Public Class TaskFactory(Of TResult)

public class TaskFactory<TResult>

Type Parameters

  • TResult
    The type of the results that are available though the Task<TResult> objects that are associated with the methods in this class.

The TaskFactory<TResult> type exposes the following members.

Constructors

  Name Description
Public method TaskFactory<TResult>() Initializes a TaskFactory<TResult> instance with the default configuration.
Public method TaskFactory<TResult>(CancellationToken) Initializes a TaskFactory<TResult> instance with the default configuration.
Public method TaskFactory<TResult>(TaskScheduler) Initializes a TaskFactory<TResult> instance with the specified configuration.
Public method TaskFactory<TResult>(TaskCreationOptions, TaskContinuationOptions) Initializes a TaskFactory<TResult> instance with the specified configuration.
Public method TaskFactory<TResult>(CancellationToken, TaskCreationOptions, TaskContinuationOptions, TaskScheduler) Initializes a TaskFactory<TResult> instance with the specified configuration.

Top

Properties

  Name Description
Public property CancellationToken Gets the default CancellationToken of this TaskFactory.
Public property ContinuationOptions Gets the TaskCreationOptions value of this TaskFactory{TResult}.
Public property CreationOptions Gets the TaskCreationOptions value of this TaskFactory{TResult}.
Public property Scheduler Gets the TaskScheduler of this TaskFactory{TResult}.

Top

Methods

  Name Description
Public method ContinueWhenAll(array<Task[], Func<array<Task[], TResult>) Creates a continuation Task<TResult> that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll(array<Task[], Func<array<Task[], TResult>, CancellationToken) Creates a continuation Task<TResult> that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll(array<Task[], Func<array<Task[], TResult>, TaskContinuationOptions) Creates a continuation Task<TResult> that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll(array<Task[], Func<array<Task[], TResult>, CancellationToken, TaskContinuationOptions, TaskScheduler) Creates a continuation Task<TResult> that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll<TAntecedentResult>(array<Task<TAntecedentResult>[], Func<array<Task<TAntecedentResult>[], TResult>) Creates a continuation Task<TResult> that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll<TAntecedentResult>(array<Task<TAntecedentResult>[], Func<array<Task<TAntecedentResult>[], TResult>, CancellationToken) Creates a continuation Task<TResult> that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll<TAntecedentResult>(array<Task<TAntecedentResult>[], Func<array<Task<TAntecedentResult>[], TResult>, TaskContinuationOptions) Creates a continuation Task<TResult> that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll<TAntecedentResult>(array<Task<TAntecedentResult>[], Func<array<Task<TAntecedentResult>[], TResult>, CancellationToken, TaskContinuationOptions, TaskScheduler) Creates a continuation Task<TResult> that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAny(array<Task[], Func<Task, TResult>) Creates a continuation Task<TResult> that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny(array<Task[], Func<Task, TResult>, CancellationToken) Creates a continuation Task<TResult> that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny(array<Task[], Func<Task, TResult>, TaskContinuationOptions) Creates a continuation Task<TResult> that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny(array<Task[], Func<Task, TResult>, CancellationToken, TaskContinuationOptions, TaskScheduler) Creates a continuation Task<TResult> that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny<TAntecedentResult>(array<Task<TAntecedentResult>[], Func<Task<TAntecedentResult>, TResult>) Creates a continuation Task<TResult> that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny<TAntecedentResult>(array<Task<TAntecedentResult>[], Func<Task<TAntecedentResult>, TResult>, CancellationToken) Creates a continuation Task<TResult> that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny<TAntecedentResult>(array<Task<TAntecedentResult>[], Func<Task<TAntecedentResult>, TResult>, TaskContinuationOptions) Creates a continuation Task<TResult> that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny<TAntecedentResult>(array<Task<TAntecedentResult>[], Func<Task<TAntecedentResult>, TResult>, CancellationToken, TaskContinuationOptions, TaskScheduler) Creates a continuation Task<TResult> that will be started upon the completion of any Task in the provided set.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public method FromAsync(IAsyncResult, Func<IAsyncResult, TResult>) Creates a Task<TResult> that executes an end method function when a specified IAsyncResult completes.
Public method FromAsync(Func<AsyncCallback, Object, IAsyncResult>, Func<IAsyncResult, TResult>, Object) Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync(IAsyncResult, Func<IAsyncResult, TResult>, TaskCreationOptions) Creates a Task<TResult> that executes an end method function when a specified IAsyncResult completes.
Public method FromAsync(Func<AsyncCallback, Object, IAsyncResult>, Func<IAsyncResult, TResult>, Object, TaskCreationOptions) Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync(IAsyncResult, Func<IAsyncResult, TResult>, TaskCreationOptions, TaskScheduler) Creates a Task<TResult> that executes an end method function when a specified IAsyncResult completes.
Public method FromAsync<TArg1>(Func<TArg1, AsyncCallback, Object, IAsyncResult>, Func<IAsyncResult, TResult>, TArg1, Object) Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync<TArg1>(Func<TArg1, AsyncCallback, Object, IAsyncResult>, Func<IAsyncResult, TResult>, TArg1, Object, TaskCreationOptions) Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync<TArg1, TArg2>(Func<TArg1, TArg2, AsyncCallback, Object, IAsyncResult>, Func<IAsyncResult, TResult>, TArg1, TArg2, Object) Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync<TArg1, TArg2>(Func<TArg1, TArg2, AsyncCallback, Object, IAsyncResult>, Func<IAsyncResult, TResult>, TArg1, TArg2, Object, TaskCreationOptions) Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync<TArg1, TArg2, TArg3>(Func<TArg1, TArg2, TArg3, AsyncCallback, Object, IAsyncResult>, Func<IAsyncResult, TResult>, TArg1, TArg2, TArg3, Object) Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync<TArg1, TArg2, TArg3>(Func<TArg1, TArg2, TArg3, AsyncCallback, Object, IAsyncResult>, Func<IAsyncResult, TResult>, TArg1, TArg2, TArg3, Object, TaskCreationOptions) Creates a Task<TResult> that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method StartNew(Func<TResult>) Creates and starts a Task<TResult>.
Public method StartNew(Func<TResult>, CancellationToken) Creates and starts a Task<TResult>.
Public method StartNew(Func<TResult>, TaskCreationOptions) Creates and starts a Task<TResult>.
Public method StartNew(Func<Object, TResult>, Object) Creates and starts a Task<TResult>.
Public method StartNew(Func<Object, TResult>, Object, CancellationToken) Creates and starts a Task<TResult>.
Public method StartNew(Func<Object, TResult>, Object, TaskCreationOptions) Creates and starts a Task<TResult>.
Public method StartNew(Func<TResult>, CancellationToken, TaskCreationOptions, TaskScheduler) Creates and starts a Task<TResult>.
Public method StartNew(Func<Object, TResult>, Object, CancellationToken, TaskCreationOptions, TaskScheduler) Creates and starts a Task<TResult>.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

The TaskFactory<TResult> class encodes some common Task<TResult> patterns into methods that pick up default settings, which are configurable through its constructors.

A default instance of TaskFactory<TResult> is available through the Factory property.

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

All public and protected members of TaskFactory<TResult> are thread-safe and may be used concurrently from multiple threads.