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

Asynchronously receives a value from a specified source and provides a token to cancel the operation.

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

Syntax

C++

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

Parameters

source: Type: System.Threading.Tasks.Dataflow::ISourceBlock<TOutput>^
The source from which to receive the value.

cancellationToken: Type: System.Threading::CancellationToken
The token to use to cancel the receive operation.

Return Value

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

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

Type Parameters

TOutput: Specifies the type of data contained in the source.

Exceptions

Exception	Condition
ArgumentNullException	source is null.