0 out of 1 rated this helpful - Rate this topic

TaskFactory Class

Provides support for creating and scheduling Task objects.

System.Object
  System.Threading.Tasks.TaskFactory

Namespace:  System.Threading.Tasks
Assembly:  mscorlib (in mscorlib.dll)
[HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true, 
	ExternalThreading = true)]
public class TaskFactory

The TaskFactory type exposes the following members.

  Name Description
Public method TaskFactory() Initializes a TaskFactory instance with the default configuration.
Public method TaskFactory(CancellationToken) Initializes a TaskFactory instance with the specified configuration.
Public method TaskFactory(TaskScheduler) Initializes a TaskFactory instance with the specified configuration.
Public method TaskFactory(TaskCreationOptions, TaskContinuationOptions) Initializes a TaskFactory instance with the specified configuration.
Public method TaskFactory(CancellationToken, TaskCreationOptions, TaskContinuationOptions, TaskScheduler) Initializes a TaskFactory instance with the specified configuration.
Top
  Name Description
Public property CancellationToken Gets the default CancellationToken of this TaskFactory.
Public property ContinuationOptions Gets the TaskContinuationOptions value of this TaskFactory.
Public property CreationOptions Gets the TaskCreationOptions value of this TaskFactory.
Public property Scheduler Gets the TaskScheduler of this TaskFactory.
Top
  Name Description
Public method ContinueWhenAll(Task[], Action<Task[]>) Creates a continuation Task that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll(Task[], Action<Task[]>, CancellationToken) Creates a continuation Task that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll(Task[], Action<Task[]>, TaskContinuationOptions) Creates a continuation Task that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll(Task[], Action<Task[]>, CancellationToken, TaskContinuationOptions, TaskScheduler) Creates a continuation Task that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll<TResult>(Task[], Func<Task[], TResult>) Creates a continuation Task that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll<TAntecedentResult>(Task<TAntecedentResult>[], Action<Task<TAntecedentResult>[]>) Creates a continuation Task that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll<TResult>(Task[], Func<Task[], TResult>, CancellationToken) Creates a continuation Task that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll<TResult>(Task[], Func<Task[], TResult>, TaskContinuationOptions) Creates a continuation Task<TResult> that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll<TAntecedentResult>(Task<TAntecedentResult>[], Action<Task<TAntecedentResult>[]>, CancellationToken) Creates a continuation Task that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll<TAntecedentResult>(Task<TAntecedentResult>[], Action<Task<TAntecedentResult>[]>, TaskContinuationOptions) Creates a continuation Task that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll<TResult>(Task[], Func<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>(Task<TAntecedentResult>[], Action<Task<TAntecedentResult>[]>, CancellationToken, TaskContinuationOptions, TaskScheduler) Creates a continuation Task that will be started upon the completion of a set of provided Tasks.
Public method ContinueWhenAll<TAntecedentResult, TResult>(Task<TAntecedentResult>[], Func<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, TResult>(Task<TAntecedentResult>[], Func<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, TResult>(Task<TAntecedentResult>[], Func<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, TResult>(Task<TAntecedentResult>[], Func<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(Task[], Action<Task>) Creates a continuation Task that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny(Task[], Action<Task>, CancellationToken) Creates a continuation Task that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny(Task[], Action<Task>, TaskContinuationOptions) Creates a continuation Task that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny(Task[], Action<Task>, CancellationToken, TaskContinuationOptions, TaskScheduler) Creates a continuation Task that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny<TResult>(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<TAntecedentResult>(Task<TAntecedentResult>[], Action<Task<TAntecedentResult>>) Creates a continuation Task that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny<TResult>(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<TResult>(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<TAntecedentResult>(Task<TAntecedentResult>[], Action<Task<TAntecedentResult>>, CancellationToken) Creates a continuation Task that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny<TAntecedentResult>(Task<TAntecedentResult>[], Action<Task<TAntecedentResult>>, TaskContinuationOptions) Creates a continuation Task that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny<TResult>(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>(Task<TAntecedentResult>[], Action<Task<TAntecedentResult>>, CancellationToken, TaskContinuationOptions, TaskScheduler) Creates a continuation Task that will be started upon the completion of any Task in the provided set.
Public method ContinueWhenAny<TAntecedentResult, TResult>(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, TResult>(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, TResult>(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, TResult>(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 it is reclaimed by garbage collection. (Inherited from Object.)
Public method FromAsync(IAsyncResult, Action<IAsyncResult>) Creates a Task that executes an end method action when a specified IAsyncResult completes.
Public method FromAsync(Func<AsyncCallback, Object, IAsyncResult>, Action<IAsyncResult>, Object) Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync(IAsyncResult, Action<IAsyncResult>, TaskCreationOptions) Creates a Task that executes an end method action when a specified IAsyncResult completes.
Public method FromAsync(Func<AsyncCallback, Object, IAsyncResult>, Action<IAsyncResult>, Object, TaskCreationOptions) Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync(IAsyncResult, Action<IAsyncResult>, TaskCreationOptions, TaskScheduler) Creates a Task that executes an end method action when a specified IAsyncResult completes.
Public method FromAsync<TResult>(IAsyncResult, Func<IAsyncResult, TResult>) Creates a Task<TResult> that executes an end method function when a specified IAsyncResult completes.
Public method FromAsync<TResult>(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<TResult>(IAsyncResult, Func<IAsyncResult, TResult>, TaskCreationOptions) Creates a Task<TResult> that executes an end method function when a specified IAsyncResult completes.
Public method FromAsync<TResult>(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<TArg1>(Func<TArg1, AsyncCallback, Object, IAsyncResult>, Action<IAsyncResult>, TArg1, Object) Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync<TResult>(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>, Action<IAsyncResult>, TArg1, Object, TaskCreationOptions) Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync<TArg1, TResult>(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, TResult>(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>, Action<IAsyncResult>, TArg1, TArg2, Object) Creates a Task 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>, Action<IAsyncResult>, TArg1, TArg2, Object, TaskCreationOptions) Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync<TArg1, TArg2, TResult>(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, TResult>(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>, Action<IAsyncResult>, TArg1, TArg2, TArg3, Object) Creates a Task 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>, Action<IAsyncResult>, TArg1, TArg2, TArg3, Object, TaskCreationOptions) Creates a Task that represents a pair of begin and end methods that conform to the Asynchronous Programming Model pattern.
Public method FromAsync<TArg1, TArg2, TArg3, TResult>(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, TResult>(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(Action) Creates and starts a Task.
Public method StartNew(Action, CancellationToken) Creates and starts a Task.
Public method StartNew(Action, TaskCreationOptions) Creates and starts a Task.
Public method StartNew(Action<Object>, Object) Creates and starts a Task.
Public method StartNew(Action<Object>, Object, CancellationToken) Creates and starts a Task.
Public method StartNew(Action<Object>, Object, TaskCreationOptions) Creates and starts a Task.
Public method StartNew(Action, CancellationToken, TaskCreationOptions, TaskScheduler) Creates and starts a Task.
Public method StartNew(Action<Object>, Object, CancellationToken, TaskCreationOptions, TaskScheduler) Creates and starts a Task.
Public method StartNew<TResult>(Func<TResult>) Creates and starts a Task<TResult>.
Public method StartNew<TResult>(Func<TResult>, CancellationToken) Creates and starts a Task<TResult>.
Public method StartNew<TResult>(Func<TResult>, TaskCreationOptions) Creates and starts a Task<TResult>.
Public method StartNew<TResult>(Func<Object, TResult>, Object) Creates and starts a Task<TResult>.
Public method StartNew<TResult>(Func<Object, TResult>, Object, CancellationToken) Creates and starts a Task<TResult>.
Public method StartNew<TResult>(Func<Object, TResult>, Object, TaskCreationOptions) Creates and starts a Task<TResult>.
Public method StartNew<TResult>(Func<TResult>, CancellationToken, TaskCreationOptions, TaskScheduler) Creates and starts a Task<TResult>.
Public method StartNew<TResult>(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

The TaskFactory class encodes some common Task patterns into methods that pick up default settings, which are configurable through its constructors. A default instance of TaskFactory is available through the Factory property.

Note Note

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization | ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ