WriteOnceBlock<T>.ISourceBlock<T>.ConsumeMessage メソッド

定義

名前空間:

System.Threading.Tasks.Dataflow

アセンブリ:

System.Threading.Tasks.Dataflow.dll

ソース:

WriteOnceBlock.cs

前にこの ITargetBlock<TInput> によって提供された DataflowMessageHeader を受け入れて使用するために、リンクされた ISourceBlock<TOutput> によって呼び出されます。

 virtual T System.Threading.Tasks.Dataflow.ISourceBlock<T>.ConsumeMessage(System::Threading::Tasks::Dataflow::DataflowMessageHeader messageHeader, System::Threading::Tasks::Dataflow::ITargetBlock<T> ^ target, [Runtime::InteropServices::Out] bool % messageConsumed) = System::Threading::Tasks::Dataflow::ISourceBlock<T>::ConsumeMessage;

T ISourceBlock<T>.ConsumeMessage (System.Threading.Tasks.Dataflow.DataflowMessageHeader messageHeader, System.Threading.Tasks.Dataflow.ITargetBlock<T> target, out bool messageConsumed);

abstract member System.Threading.Tasks.Dataflow.ISourceBlock<T>.ConsumeMessage : System.Threading.Tasks.Dataflow.DataflowMessageHeader * System.Threading.Tasks.Dataflow.ITargetBlock<'T> * bool -> 'T
override this.System.Threading.Tasks.Dataflow.ISourceBlock<T>.ConsumeMessage : System.Threading.Tasks.Dataflow.DataflowMessageHeader * System.Threading.Tasks.Dataflow.ITargetBlock<'T> * bool -> 'T

Function ConsumeMessage (messageHeader As DataflowMessageHeader, target As ITargetBlock(Of T), ByRef messageConsumed As Boolean) As T Implements ISourceBlock(Of T).ConsumeMessage

パラメーター

messageHeader

DataflowMessageHeader

使用中のメッセージの DataflowMessageHeader。

target

ITargetBlock<T>

メッセージを使用している ITargetBlock<TInput>。

messageConsumed

Boolean

メッセージが正常に使用された場合は true、それ以外の場合は false。

戻り値

T

使用されたメッセージの値。 これは以前に予約されて DataflowMessageHeader に messageHeader として渡されたものとは異なる、ConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>, Boolean) のインスタンスに相当する場合があります。 使用する側の ITargetBlock<TInput> は、OfferMessage(DataflowMessageHeader, TInput, ISourceBlock<TInput>, Boolean) によって messageValue として渡される値の代わりに、戻り値を使用する必要があります。

要求されたメッセージを使用できない場合、戻り値は null になります。

実装

ConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>, Boolean)

例外

ArgumentException

messageHeader が有効ではありません。

ArgumentNullException

target が null です。

注釈

このISourceBlock<TOutput>インスタンスにリンクされているインスタンスのみが ITargetBlock<TInput> を使用ConsumeMessageでき、ターゲットに対してこのソースによって以前に提供されたインスタンスの使用DataflowMessageHeaderにのみ使用する必要があります。