TaskCompletionSourceExtensions.TrySetFromTask(TSource, TResult) Method (TaskCompletionSource(TResult), Task(TSource))

TaskCompletionSourceExtensionsTrySetFromTaskTSource, TResult Method (TaskCompletionSourceTResult, TaskTSource)

Attempts to transfer the result of a TaskTResult to a TaskCompletionSourceTResult.

Namespace: Rackspace.Threading
Assembly: Rackspace.Threading (in Rackspace.Threading.dll) Version: 1.1.0.0

Syntax

public static bool TrySetFromTask<TSource, TResult>(
	this TaskCompletionSource<TResult> taskCompletionSource,
	Task<TSource> task
)
where TSource : TResult

<ExtensionAttribute>
Public Shared Function TrySetFromTask(Of TSource As TResult, TResult) ( 
	taskCompletionSource As TaskCompletionSource(Of TResult),
	task As Task(Of TSource)
) As Boolean

public:
[ExtensionAttribute]
generic<typename TSource, typename TResult>
where TSource : TResult
static bool TrySetFromTask(
	TaskCompletionSource<TResult>^ taskCompletionSource, 
	Task<TSource>^ task
)

[<ExtensionAttribute>]
static member TrySetFromTask : 
        taskCompletionSource : TaskCompletionSource<'TResult> * 
        task : Task<'TSource> -> bool  when 'TSource : 'TResult

Parameters

taskCompletionSource: Type: System.Threading.TasksTaskCompletionSourceTResult
The TaskCompletionSourceTResult instance.
task: Type: System.Threading.TasksTaskTSource
The result task whose completion results should be transferred.

Type Parameters

TSource: Specifies the result type of the source TaskTResult.
TResult: Specifies the result type of the TaskCompletionSourceTResult.

Return Value

Type: Boolean
if the operation was successful.

-or-

if the operation was unsuccessful or the object has already been disposed.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type TaskCompletionSourceTResult. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	If taskCompletionSource is . -or- If task is .

Exception

Condition

ArgumentNullException

If taskCompletionSource is .

-or-

If task is .

Remarks

This method will return if the TaskTResult provided by taskCompletionSource is already in one of the three final states: RanToCompletion, Faulted, or Canceled. This method also returns if the underlying TaskTResult has already been disposed.

If task is in the RanToCompletion state, the result of the task is assigned to the TaskCompletionSourceTResult using the TrySetResult(TResult) method.

If task is in the Faulted state, the unwrapped exceptions are bound to the TaskCompletionSourceTResult using the TrySetException(IEnumerableException) method.

If task is in the Canceled state, the TaskCompletionSourceTResult is transitioned to the Canceled state using the TrySetCanceled method.

Version Information

.NET for Windows Store apps

Supported in: Windows 8

.NET Framework

Supported in: 4.5, 4.0, 3.5

Portable Class Library

Supported in: Portable Class Library (Legacy), Portable Class Library

Rackspace Threading Library

Supported in: 1.1

Reference

TaskCompletionSourceExtensions Class

TrySetFromTask Overload

Rackspace.Threading Namespace