JoinBlock<T1, T2>::ISourceBlock<Tuple<T1, T2>^>::ReserveMessage Method (DataflowMessageHeader, ITargetBlock<Tuple<T1, T2>^>^)

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

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

Syntax

C++

private:
virtual bool ReserveMessage(
	DataflowMessageHeader messageHeader,
	ITargetBlock<Tuple<T1, T2>^>^ target
) sealed = ISourceBlock<Tuple<T1, T2>^>::ReserveMessage

Parameters

messageHeader: Type: System.Threading.Tasks.Dataflow::DataflowMessageHeader
The DataflowMessageHeader of the message being reserved.

target: Type: System.Threading.Tasks.Dataflow::ITargetBlock<Tuple<T1, T2>^>^
The ITargetBlock<TInput> reserving the message.

Return Value

Type: System::Boolean

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

Implements

ISourceBlock<TOutput>::ReserveMessage(DataflowMessageHeader, ITargetBlock<TOutput>^)

Exceptions

Exception	Condition
ArgumentException	The messageHeader is not valid.
ArgumentNullException	The target is null.

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

If true is returned, the ITargetBlock<TInput> must subsequently call either ConsumeMessage or ReleaseReservation for this message. Failure to do so may result in the source being unable to propagate any further messages to this or other targets.

ReserveMessage must not be called while the target is holding any internal locks. Doing so will violate the lock hierarchy necessary to avoid deadlocks in a dataflow network.