DataflowBlock::SendAsync<TInput> Method (ITargetBlock<TInput>^, TInput)

 

Asynchronously offers a message to the target message block, allowing for postponement.

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

public:
generic<typename TInput>
[ExtensionAttribute]
static Task<bool>^ SendAsync(
	ITargetBlock<TInput>^ target,
	TInput item
)

Parameters

target
Type: System.Threading.Tasks.Dataflow::ITargetBlock<TInput>^

The target to which to post the data.

item
Type: TInput

The item being offered to the target.

Return Value

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

A Task<TResult> that represents the asynchronous send. If the target accepts and consumes the offered element during the call to SendAsync<TInput>, upon return from the call the resulting Task<TResult> will be completed and its Result property will return true. If the target declines the offered element during the call, upon return from the call the resulting Task<TResult> will be completed and its Result property will return false. If the target postpones the offered element, the element will be buffered until such time that the target consumes or releases it, at which point the task will complete, with its Result indicating whether the message was consumed. If the target never attempts to consume or release the message, the returned task will never complete.

Type Parameters

TInput

Specifies the type of the data to post to the target.

Exception Condition
ArgumentNullException

The target is null.

Return to top
Show: