DataflowBlock::ReceiveAsync<TOutput> Method (ISourceBlock<TOutput>^)

 

Asynchronously receives a value from a specified source.

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

public:
generic<typename TOutput>
[ExtensionAttribute]
static Task<TOutput>^ ReceiveAsync(
	ISourceBlock<TOutput>^ source
)

Parameters

source
Type: System.Threading.Tasks.Dataflow::ISourceBlock<TOutput>^

The source from which to receive the value.

Return Value

Type: System.Threading.Tasks::Task<TOutput>^

A task that represents the asynchronous receive operation. When an item value is successfully received from the source, the returned task is completed and its Result returns the received value. If an item value cannot be retrieved because the source is empty and completed , an InvalidOperationException exception is thrown in the returned task.

Type Parameters

TOutput

The type of data contained in the source.

Exception Condition
ArgumentNullException

source is null.

Return to top
Show: