Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

BatchedJoinBlock<T1, T2, T3>.ISourceBlock<Tuple<IList<T1>, IList<T2>, IList<T3>>>.ConsumeMessage Method

.NET Framework 4.6 and 4.5

Called by a linked ITargetBlock<TInput> to accept and consume a DataflowMessageHeader previously offered by this ISourceBlock<TOutput>.

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

Tuple<IList<T1>, IList<T2>, IList<T3>> ISourceBlock<Tuple<IList<T1>, IList<T2>, IList<T3>>>.ConsumeMessage(
	DataflowMessageHeader messageHeader,
	ITargetBlock<Tuple<IList<T1>, IList<T2>, IList<T3>>> target,
	out bool messageConsumed
)

Parameters

messageHeader
Type: System.Threading.Tasks.Dataflow.DataflowMessageHeader

The DataflowMessageHeader of the message being consumed.

target
Type: System.Threading.Tasks.Dataflow.ITargetBlock<Tuple<IList<T1>, IList<T2>, IList<T3>>>

The ITargetBlock<TInput> consuming the message.

messageConsumed
Type: System.Boolean

true if the message was successfully consumed; otherwise, false.

Return Value

Type: System.Tuple<IList<T1>, IList<T2>, IList<T3>>
The value of the consumed message. This may correspond to a different DataflowMessageHeader instance than was previously reserved and passed as the messageHeader to ConsumeMessage. The consuming ITargetBlock<TInput> must use the returned value instead of the value passed as messageValue through OfferMessage.
If the message requested is not available, the return value will be null.

Implements

ISourceBlock<TOutput>.ConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>, Boolean)

ExceptionCondition
ArgumentException

The messageHeader is not valid.

ArgumentNullException

The target is null.

Only ITargetBlock<TInput> instances linked to this ISourceBlock<TOutput> instance may use ConsumeMessage, and it must only be used to consume DataflowMessageHeader instances previously offered by this source to the target.

.NET Framework

Supported in: 4.5

Portable Class Library

Supported in: Portable Class Library
Show:
© 2015 Microsoft