JoinBlock<T1,T2>.ISourceBlock<Tuple<T1,T2>>.ReserveMessage Method

Reference

Definition

Namespace:: System.Threading.Tasks.Dataflow

Assembly:: System.Threading.Tasks.Dataflow.dll

Package:: System.Threading.Tasks.Dataflow v8.0.1

Package:: System.Threading.Tasks.Dataflow v9.0.0-rc.2.24473.5

Source:: JoinBlock.cs

Source:: JoinBlock.cs

Source:: JoinBlock.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Reserves the right to pass the ownership of the message identified by the DataflowMessageHeader from this ISourceBlock<TOutput> to the ITargetBlock<TInput>.

 virtual bool System.Threading.Tasks.Dataflow.ISourceBlock<System.Tuple<T1,T2>>.ReserveMessage(System::Threading::Tasks::Dataflow::DataflowMessageHeader messageHeader, System::Threading::Tasks::Dataflow::ITargetBlock<Tuple<T1, T2> ^> ^ target) = System::Threading::Tasks::Dataflow::ISourceBlock<Tuple<T1, T2> ^>::ReserveMessage;

bool ISourceBlock<Tuple<T1,T2>>.ReserveMessage (System.Threading.Tasks.Dataflow.DataflowMessageHeader messageHeader, System.Threading.Tasks.Dataflow.ITargetBlock<Tuple<T1,T2>> target);

abstract member System.Threading.Tasks.Dataflow.ISourceBlock<System.Tuple<T1,T2>>.ReserveMessage : System.Threading.Tasks.Dataflow.DataflowMessageHeader * System.Threading.Tasks.Dataflow.ITargetBlock<'T1 * 'T2> -> bool
override this.System.Threading.Tasks.Dataflow.ISourceBlock<System.Tuple<T1,T2>>.ReserveMessage : System.Threading.Tasks.Dataflow.DataflowMessageHeader * System.Threading.Tasks.Dataflow.ITargetBlock<'T1 * 'T2> -> bool

Function ReserveMessage (messageHeader As DataflowMessageHeader, target As ITargetBlock(Of Tuple(Of T1, T2))) As Boolean Implements ISourceBlock(Of Tuple(Of T1, T2)).ReserveMessage

Parameters

messageHeader: DataflowMessageHeader

The DataflowMessageHeader of the message that is to be reserved.

target: ITargetBlock<Tuple<T1,T2>>

The ITargetBlock<TInput> for which the message is to be reserved.

Returns

Boolean

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

Implements

ReserveMessage(DataflowMessageHeader, ITargetBlock<TOutput>)

Exceptions

ArgumentException

The messageHeader is not valid.

ArgumentNullException

The target is null (Nothing in Visual Basic).

Remarks

The ITargetBlock<TInput> for which the message is to be reserved need not be linked from this ISourceBlock<TOutput> instance. Moreover, this ISourceBlock<TOutput> instance may have never offered the message directly to the ITargetBlock<TInput>.

If true is returned, you must subsequently call either ConsumeMessage or ReleaseReservation for this message with the same DataflowMessageHeader and ITargetBlock<TInput>. If you don't, the source may be unable to propagate any further messages to any target.

Don't call ReserveMessage while the target is holding any internal locks. Doing so will violate the lock hierarchy necessary to avoid deadlocks in a dataflow network.

Applies to

Share via