System.Threading.Tasks.Task< TResult > Class Template Reference

Classes
class	CancellationPromise
class	ContingentProperties
class	DelayPromise
class	DelayPromiseWithCancellation
class	SetOnCountdownMres
class	SetOnInvokeMres
class	TaskWhenAnyCast
class	TwoTaskWhenAnyPromise
class	WhenAllPromise

Public Member Functions
	Task (Func< TResult > function)
	Task (Func< TResult > function, CancellationToken cancellationToken)
	Task (Func< TResult > function, TaskCreationOptions creationOptions)
	Task (Func< TResult > function, CancellationToken cancellationToken, TaskCreationOptions creationOptions)
	Task (Func< object?, TResult > function, object? state)
	Task (Func< object?, TResult > function, object? state, CancellationToken cancellationToken)
	Task (Func< object?, TResult > function, object? state, TaskCreationOptions creationOptions)
	Task (Func< object?, TResult > function, object? state, CancellationToken cancellationToken, TaskCreationOptions creationOptions)
new TaskAwaiter< TResult >	GetAwaiter ()
new ConfiguredTaskAwaitable< TResult >	ConfigureAwait (bool continueOnCapturedContext)
new Task< TResult >	WaitAsync (CancellationToken cancellationToken)
new Task< TResult >	WaitAsync (TimeSpan timeout)
new Task< TResult >	WaitAsync (TimeSpan timeout, CancellationToken cancellationToken)
Task	ContinueWith (Action< Task< TResult > > continuationAction)
Task	ContinueWith (Action< Task< TResult > > continuationAction, CancellationToken cancellationToken)
Task	ContinueWith (Action< Task< TResult > > continuationAction, TaskScheduler scheduler)
Task	ContinueWith (Action< Task< TResult > > continuationAction, TaskContinuationOptions continuationOptions)
Task	ContinueWith (Action< Task< TResult > > continuationAction, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions, TaskScheduler scheduler)
Task	ContinueWith (Action< Task< TResult >, object?> continuationAction, object? state)
Task	ContinueWith (Action< Task< TResult >, object?> continuationAction, object? state, CancellationToken cancellationToken)
Task	ContinueWith (Action< Task< TResult >, object?> continuationAction, object? state, TaskScheduler scheduler)
Task	ContinueWith (Action< Task< TResult >, object?> continuationAction, object? state, TaskContinuationOptions continuationOptions)
Task	ContinueWith (Action< Task< TResult >, object?> continuationAction, object? state, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions, TaskScheduler scheduler)
Task< TNewResult >	ContinueWith< TNewResult > (Func< Task< TResult >, TNewResult > continuationFunction)
Task< TNewResult >	ContinueWith< TNewResult > (Func< Task< TResult >, TNewResult > continuationFunction, CancellationToken cancellationToken)
Task< TNewResult >	ContinueWith< TNewResult > (Func< Task< TResult >, TNewResult > continuationFunction, TaskScheduler scheduler)
Task< TNewResult >	ContinueWith< TNewResult > (Func< Task< TResult >, TNewResult > continuationFunction, TaskContinuationOptions continuationOptions)
Task< TNewResult >	ContinueWith< TNewResult > (Func< Task< TResult >, TNewResult > continuationFunction, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions, TaskScheduler scheduler)
Task< TNewResult >	ContinueWith< TNewResult > (Func< Task< TResult >, object?, TNewResult > continuationFunction, object? state)
Task< TNewResult >	ContinueWith< TNewResult > (Func< Task< TResult >, object?, TNewResult > continuationFunction, object? state, CancellationToken cancellationToken)
Task< TNewResult >	ContinueWith< TNewResult > (Func< Task< TResult >, object?, TNewResult > continuationFunction, object? state, TaskScheduler scheduler)
Task< TNewResult >	ContinueWith< TNewResult > (Func< Task< TResult >, object?, TNewResult > continuationFunction, object? state, TaskContinuationOptions continuationOptions)
Task< TNewResult >	ContinueWith< TNewResult > (Func< Task< TResult >, object?, TNewResult > continuationFunction, object? state, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions, TaskScheduler scheduler)
	Task (Action action)
	Task (Action action, CancellationToken cancellationToken)
	Task (Action action, TaskCreationOptions creationOptions)
	Task (Action action, CancellationToken cancellationToken, TaskCreationOptions creationOptions)
	Task (Action< object?> action, object? state)
	Task (Action< object?> action, object? state, CancellationToken cancellationToken)
	Task (Action< object?> action, object? state, TaskCreationOptions creationOptions)
	Task (Action< object?> action, object? state, CancellationToken cancellationToken, TaskCreationOptions creationOptions)
void	Start ()
void	Start (TaskScheduler scheduler)
void	RunSynchronously ()
void	RunSynchronously (TaskScheduler scheduler)
void	Dispose ()
TaskAwaiter	GetAwaiter ()
ConfiguredTaskAwaitable	ConfigureAwait (bool continueOnCapturedContext)
void	Wait ()
bool	Wait (TimeSpan timeout)
void	Wait (CancellationToken cancellationToken)
bool	Wait (int millisecondsTimeout)
bool	Wait (int millisecondsTimeout, CancellationToken cancellationToken)
Task	WaitAsync (CancellationToken cancellationToken)
Task	WaitAsync (TimeSpan timeout)
Task	WaitAsync (TimeSpan timeout, CancellationToken cancellationToken)
Task	ContinueWith (Action< Task > continuationAction)
Task	ContinueWith (Action< Task > continuationAction, CancellationToken cancellationToken)
Task	ContinueWith (Action< Task > continuationAction, TaskScheduler scheduler)
Task	ContinueWith (Action< Task > continuationAction, TaskContinuationOptions continuationOptions)
Task	ContinueWith (Action< Task > continuationAction, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions, TaskScheduler scheduler)
Task	ContinueWith (Action< Task, object?> continuationAction, object? state)
Task	ContinueWith (Action< Task, object?> continuationAction, object? state, CancellationToken cancellationToken)
Task	ContinueWith (Action< Task, object?> continuationAction, object? state, TaskScheduler scheduler)
Task	ContinueWith (Action< Task, object?> continuationAction, object? state, TaskContinuationOptions continuationOptions)
Task	ContinueWith (Action< Task, object?> continuationAction, object? state, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions, TaskScheduler scheduler)
Task< TResult >	ContinueWith< TResult > (Func< Task, TResult > continuationFunction)
Task< TResult >	ContinueWith< TResult > (Func< Task, TResult > continuationFunction, CancellationToken cancellationToken)
Task< TResult >	ContinueWith< TResult > (Func< Task, TResult > continuationFunction, TaskScheduler scheduler)
Task< TResult >	ContinueWith< TResult > (Func< Task, TResult > continuationFunction, TaskContinuationOptions continuationOptions)
Task< TResult >	ContinueWith< TResult > (Func< Task, TResult > continuationFunction, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions, TaskScheduler scheduler)
Task< TResult >	ContinueWith< TResult > (Func< Task, object?, TResult > continuationFunction, object? state)
Task< TResult >	ContinueWith< TResult > (Func< Task, object?, TResult > continuationFunction, object? state, CancellationToken cancellationToken)
Task< TResult >	ContinueWith< TResult > (Func< Task, object?, TResult > continuationFunction, object? state, TaskScheduler scheduler)
Task< TResult >	ContinueWith< TResult > (Func< Task, object?, TResult > continuationFunction, object? state, TaskContinuationOptions continuationOptions)
Task< TResult >	ContinueWith< TResult > (Func< Task, object?, TResult > continuationFunction, object? state, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions, TaskScheduler scheduler)

Static Public Member Functions
static YieldAwaitable	Yield ()
static void	WaitAll (params Task[] tasks)
static bool	WaitAll (Task[] tasks, TimeSpan timeout)
static bool	WaitAll (Task[] tasks, int millisecondsTimeout)
static void	WaitAll (Task[] tasks, CancellationToken cancellationToken)
static bool	WaitAll (Task[] tasks, int millisecondsTimeout, CancellationToken cancellationToken)
static int	WaitAny (params Task[] tasks)
static int	WaitAny (Task[] tasks, TimeSpan timeout)
static int	WaitAny (Task[] tasks, CancellationToken cancellationToken)
static int	WaitAny (Task[] tasks, int millisecondsTimeout)
static int	WaitAny (Task[] tasks, int millisecondsTimeout, CancellationToken cancellationToken)
static Task< TResult >	FromResult< TResult > (TResult result)
static Task	FromException (Exception exception)
static Task< TResult >	FromException< TResult > (Exception exception)
static Task	FromCanceled (CancellationToken cancellationToken)
static Task< TResult >	FromCanceled< TResult > (CancellationToken cancellationToken)
static Task	Run (Action action)
static Task	Run (Action action, CancellationToken cancellationToken)
static Task< TResult >	Run< TResult > (Func< TResult > function)
static Task< TResult >	Run< TResult > (Func< TResult > function, CancellationToken cancellationToken)
static Task	Run (Func< Task?> function)
static Task	Run (Func< Task?> function, CancellationToken cancellationToken)
static Task< TResult >	Run< TResult > (Func< Task< TResult >?> function)
static Task< TResult >	Run< TResult > (Func< Task< TResult >?> function, CancellationToken cancellationToken)
static Task	Delay (TimeSpan delay)
static Task	Delay (TimeSpan delay, CancellationToken cancellationToken)
static Task	Delay (int millisecondsDelay)
static Task	Delay (int millisecondsDelay, CancellationToken cancellationToken)
static Task	WhenAll (IEnumerable< Task > tasks)
static Task	WhenAll (params Task[] tasks)
static Task< TResult[]>	WhenAll< TResult > (IEnumerable< Task< TResult > > tasks)
static Task< TResult[]>	WhenAll< TResult > (params Task< TResult >[] tasks)
static Task< Task >	WhenAny (params Task[] tasks)
static Task< Task >	WhenAny (Task task1, Task task2)
static Task< Task >	WhenAny (IEnumerable< Task > tasks)
static Task< Task< TResult > >	WhenAny< TResult > (params Task< TResult >[] tasks)
static Task< Task< TResult > >	WhenAny< TResult > (Task< TResult > task1, Task< TResult > task2)
static Task< Task< TResult > >	WhenAny< TResult > (IEnumerable< Task< TResult > > tasks)

Protected Member Functions
virtual void	Dispose (bool disposing)

Package Types
enum	TaskStateFlags {   Started = 0x10000 , DelegateInvoked = 0x20000 , Disposed = 0x40000 , ExceptionObservedByParent = 0x80000 ,   CancellationAcknowledged = 0x100000 , Faulted = 0x200000 , Canceled = 0x400000 , WaitingOnChildren = 0x800000 ,   RanToCompletion = 0x1000000 , WaitingForActivation = 0x2000000 , CompletionReserved = 0x4000000 , WaitCompletionNotification = 0x10000000 ,   ExecutionContextIsNull = 0x20000000 , TaskScheduledWasFired = 0x40000000 , CompletedMask = 0x1600000 , OptionsMask = 0xFFFF }

Package Functions
	Task ()
	Task (object state, TaskCreationOptions options)
	Task (TResult result)
	Task (bool canceled, TResult result, TaskCreationOptions creationOptions, CancellationToken ct)
	Task (Func< TResult > valueSelector, Task parent, CancellationToken cancellationToken, TaskCreationOptions creationOptions, InternalTaskOptions internalOptions, TaskScheduler scheduler)
	Task (Delegate valueSelector, object state, Task parent, CancellationToken cancellationToken, TaskCreationOptions creationOptions, InternalTaskOptions internalOptions, TaskScheduler scheduler)
bool	TrySetResult (TResult result)
void	DangerousSetResult (TResult result)
TResult	GetResultCore (bool waitCompletionNotification)
override void	InnerInvoke ()
Task	ContinueWith (Action< Task< TResult > > continuationAction, TaskScheduler scheduler, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions)
Task	ContinueWith (Action< Task< TResult >, object > continuationAction, object state, TaskScheduler scheduler, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions)
Task< TNewResult >	ContinueWith< TNewResult > (Func< Task< TResult >, TNewResult > continuationFunction, TaskScheduler scheduler, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions)
Task< TNewResult >	ContinueWith< TNewResult > (Func< Task< TResult >, object, TNewResult > continuationFunction, object state, TaskScheduler scheduler, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions)
	Task (bool canceled, TaskCreationOptions creationOptions, CancellationToken ct)
	Task ()
	Task (object state, TaskCreationOptions creationOptions, bool promiseStyle)
	Task (Delegate action, object state, Task parent, CancellationToken cancellationToken, TaskCreationOptions creationOptions, InternalTaskOptions internalOptions, TaskScheduler scheduler)
void	TaskConstructorCore (Delegate action, object state, CancellationToken cancellationToken, TaskCreationOptions creationOptions, InternalTaskOptions internalOptions, TaskScheduler scheduler)
bool	AtomicStateUpdate (int newBits, int illegalBits)
bool	AtomicStateUpdate (int newBits, int illegalBits, ref int oldFlags)
void	SetNotificationForWaitCompletion (bool enabled)
bool	NotifyDebuggerOfWaitCompletionIfNecessary ()
bool	MarkStarted ()
void	FireTaskScheduledIfNeeded (TaskScheduler ts)
void	AddNewChild ()
void	DisregardChild ()
void	InternalRunSynchronously (TaskScheduler scheduler, bool waitForCompletion)
ContingentProperties	EnsureContingentPropertiesInitialized ()
ContingentProperties	EnsureContingentPropertiesInitializedUnsafe ()
void	SpinUntilCompleted ()
void	ScheduleAndStart (bool needsProtection)
void	AddException (object exceptionObject)
void	AddException (object exceptionObject, bool representsCancellation)
List< ExceptionDispatchInfo >	GetExceptionDispatchInfos ()
ExceptionDispatchInfo	GetCancellationExceptionDispatchInfo ()
void	ThrowIfExceptional (bool includeTaskCanceledExceptions)
void	UpdateExceptionObservedStatus ()
void	Finish (bool userDelegateExecute)
void	FinishStageThree ()
void	NotifyParentIfPotentiallyAttachedTask ()
void	ProcessChildCompletion (Task childTask)
void	AddExceptionsFromChildren (ContingentProperties props)
bool	ExecuteEntry ()
virtual void	ExecuteFromThreadPool (Thread threadPoolThread)
void	ExecuteEntryUnsafe (Thread threadPoolThread)
void	ExecuteEntryCancellationRequestedOrCanceled ()
virtual void	InnerInvoke ()
void	SetContinuationForAwait (Action continuationAction, bool continueOnCapturedContext, bool flowExecutionContext)
void	UnsafeSetContinuationForAwait (IAsyncStateMachineBox stateMachineBox, bool continueOnCapturedContext)
bool	InternalWait (int millisecondsTimeout, CancellationToken cancellationToken)
void	InternalCancel ()
void	InternalCancelContinueWithInitialState ()
void	RecordInternalCancellationRequest ()
void	RecordInternalCancellationRequest (CancellationToken tokenToRecord, object cancellationException)
void	CancellationCleanupLogic ()
bool	TrySetResult ()
bool	TrySetException (object exceptionObject)
bool	TrySetCanceled (CancellationToken tokenToRecord)
bool	TrySetCanceled (CancellationToken tokenToRecord, object cancellationException)
void	FinishContinuations ()
void	ContinueWithCore (Task continuationTask, TaskScheduler scheduler, CancellationToken cancellationToken, TaskContinuationOptions options)
void	AddCompletionAction (ITaskCompletionAction action, bool addBeforeOthers=false)
void	RemoveContinuation (object continuationObject)
virtual Delegate[]	GetDelegateContinuationsForDebugger ()

Static Package Functions
static Task< TResult >	StartNew (Task parent, Func< TResult > function, CancellationToken cancellationToken, TaskCreationOptions creationOptions, InternalTaskOptions internalOptions, TaskScheduler scheduler)
static Task< TResult >	StartNew (Task parent, Func< object, TResult > function, object state, CancellationToken cancellationToken, TaskCreationOptions creationOptions, InternalTaskOptions internalOptions, TaskScheduler scheduler)
static bool	AddToActiveTasks (Task task)
static void	RemoveFromActiveTasks (Task task)
static TaskCreationOptions	OptionsMethod (int flags)
static bool	AnyTaskRequiresNotifyDebuggerOfWaitCompletion (Task[] tasks)
static Task	InternalStartNew (Task creatingTask, Delegate action, object state, CancellationToken cancellationToken, TaskScheduler scheduler, TaskCreationOptions options, InternalTaskOptions internalOptions)
static int	NewId ()
static Task	InternalCurrentIfAttached (TaskCreationOptions creationOptions)
static void	ThrowAsync (Exception exception, SynchronizationContext targetContext)
static void	CreationOptionsFromContinuationOptions (TaskContinuationOptions continuationOptions, out TaskCreationOptions creationOptions, out InternalTaskOptions internalOptions)
static void	AddExceptionsForCompletedTask (ref List< Exception > exceptions, Task t)
static Task	FromCanceled (OperationCanceledException exception)
static Task< TResult >	FromCanceled< TResult > (OperationCanceledException exception)
static uint	ValidateTimeout (TimeSpan timeout, ExceptionArgument argument)
static Task< TResult >	CreateUnwrapPromise< TResult > (Task outerTask, bool lookForOce)

Package Attributes
TResult	m_result
Delegate	m_action
object	m_stateObject
TaskScheduler	m_taskScheduler
volatile int	m_stateFlags
ContingentProperties	m_contingentProperties

Static Package Attributes
static readonly Task< TResult >	s_defaultResultTask = TaskCache.CreateCacheableTask(default(TResult))
static Task	t_currentTask
static int	s_taskIdCounter
static bool	s_asyncDebuggingEnabled
static readonly Task< VoidTaskResult >	s_cachedCompleted = new Task<VoidTaskResult>(canceled: false, default(VoidTaskResult), (TaskCreationOptions)16384, default(CancellationToken))

Properties
string	DebuggerDisplayResultDescription [get]
string	DebuggerDisplayMethodDescription [get]
TResult	Result [get]
TResult	ResultOnSuccess [get]
static new TaskFactory< TResult >	Factory [get]
Task?	ParentForDebugger [get]
int	StateFlagsForDebugger [get]
TaskStateFlags	StateFlags [get]
TaskCreationOptions	Options [get]
bool	IsWaitNotificationEnabledOrNotRanToCompletion [get]
virtual bool	ShouldNotifyDebuggerOfWaitCompletion [get]
bool	IsWaitNotificationEnabled [get]
int	Id [get]
static ? int	CurrentId [get]
static ? Task	InternalCurrent [get]
AggregateException?	Exception [get]
TaskStatus	Status [get]
bool	IsCanceled [get]
bool	IsCancellationRequested [get]
CancellationToken	CancellationToken [get]
bool	IsCancellationAcknowledged [get]
bool	IsCompleted [get]
bool	IsCompletedSuccessfully [get]
TaskCreationOptions	CreationOptions [get]
WaitHandle IAsyncResult.	AsyncWaitHandle [get]
object?	AsyncState [get]
bool IAsyncResult.	CompletedSynchronously [get]
TaskScheduler?	ExecutingTaskScheduler [get]
static TaskFactory	Factory = new TaskFactory() [get]
static Task	CompletedTask [get]
ManualResetEventSlim	CompletedEvent [get]
bool	ExceptionRecorded [get]
bool	IsFaulted [get]
ExecutionContext?	CapturedContext [get, set]
bool	IsExceptionObservedByParent [get]
bool	IsDelegateInvoked [get]

Private Member Functions
Task< TResult >	WaitAsync (uint millisecondsTimeout, CancellationToken cancellationToken)
void	AssignCancellationToken (CancellationToken cancellationToken, Task antecedent, TaskContinuation continuation)
bool	AtomicStateUpdateSlow (int newBits, int illegalBits)
void	NotifyDebuggerOfWaitCompletion ()
AggregateException	GetExceptions (bool includeTaskCanceledExceptions)
void	FinishSlow (bool userDelegateExecute)
void	FinishStageTwo ()
void	ExecuteWithThreadLocal (ref Task currentTaskSlot, Thread threadPoolThread=null)
void	HandleException (Exception unhandledException)
Task	WaitAsync (uint millisecondsTimeout, CancellationToken cancellationToken)
bool	WrappedTryRunInline ()
bool	InternalWaitCore (int millisecondsTimeout, CancellationToken cancellationToken)
bool	SpinThenBlockingWait (int millisecondsTimeout, CancellationToken cancellationToken)
bool	SpinWait (int millisecondsTimeout)
void	SetCancellationAcknowledged ()
void	RunContinuations (object continuationObject)
void	RunOrQueueCompletionAction (ITaskCompletionAction completionAction, bool allowInlining)
Task	ContinueWith (Action< Task > continuationAction, TaskScheduler scheduler, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions)
Task	ContinueWith (Action< Task, object > continuationAction, object state, TaskScheduler scheduler, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions)
Task< TResult >	ContinueWith< TResult > (Func< Task, TResult > continuationFunction, TaskScheduler scheduler, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions)
Task< TResult >	ContinueWith< TResult > (Func< Task, object, TResult > continuationFunction, object state, TaskScheduler scheduler, CancellationToken cancellationToken, TaskContinuationOptions continuationOptions)
bool	AddTaskContinuationComplex (object tc, bool addBeforeOthers)
bool	AddTaskContinuation (object tc, bool addBeforeOthers)

Static Private Member Functions
static bool	IsCompletedMethod (int flags)
static void	LogFinishCompletionNotification ()
static bool	WaitAllCore (Task[] tasks, int millisecondsTimeout, CancellationToken cancellationToken)
static void	AddToList< T > (T item, ref List< T > list, int initSize)
static bool	WaitAllBlockingCore (List< Task > tasks, int millisecondsTimeout, CancellationToken cancellationToken)
static int	WaitAnyCore (Task[] tasks, int millisecondsTimeout, CancellationToken cancellationToken)
static Task	Delay (uint millisecondsDelay, CancellationToken cancellationToken)
static Task	InternalWhenAll (Task[] tasks)
static Task< TResult[]>	InternalWhenAll< TResult > (Task< TResult >[] tasks)
static Delegate[]	GetDelegatesFromContinuationObject (object continuationObject)
static Task	GetActiveTaskFromId (int taskId)

Private Attributes
int	m_taskId
volatile object	m_continuationObject

Static Private Attributes
static TaskFactory< TResult >	s_Factory
static readonly object	s_taskCompletionSentinel = new object()
static Dictionary< int, Task >	s_currentActiveTasks
static readonly ContextCallback	s_ecCallback

Detailed Description

Definition at line 13 of file Task.cs.

---

The documentation for this class was generated from the following file:

• source/System.Private.CoreLib/System.Threading.Tasks/Task.cs