TaskFactory(TResult) Class (System.Threading.Tasks)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

TaskFactory<(Of <(TResult>)>) Class

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

Inheritance Hierarchy

System..::.Object
System.Threading.Tasks..::.TaskFactory<(Of <(TResult>)>)

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

Syntax

Visual Basic

<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization := True,  _
    ExternalThreading := True)> _
Public Class TaskFactory(Of TResult)

[HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true, 
    ExternalThreading = true)]
public class TaskFactory<TResult>

Visual C++

[HostProtectionAttribute(SecurityAction::LinkDemand, Synchronization = true, 
    ExternalThreading = true)]
generic<typename TResult>
public ref class TaskFactory

[<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true, 
    ExternalThreading = true)>]
type TaskFactory<'TResult> =  class end

Type Parameters

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

The TaskFactory<(Of <(TResult>)>) type exposes the following members.

Constructors

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

Top

Properties

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

Top

Methods

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

Top

Remarks

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

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

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.

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.

Version Information

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Platforms

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.

Thread Safety

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

Reference

System.Threading.Tasks Namespace

Other Resources

Task Parallel Library

Task Factories