ISourceBlock<TOutput>.ConsumeMessage メソッド

定義

名前空間:

System.Threading.Tasks.Dataflow

アセンブリ:

System.Threading.Tasks.Dataflow.dll

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

public TOutput? ConsumeMessage (System.Threading.Tasks.Dataflow.DataflowMessageHeader messageHeader, System.Threading.Tasks.Dataflow.ITargetBlock<out TOutput> target, out bool messageConsumed);

abstract member ConsumeMessage : System.Threading.Tasks.Dataflow.DataflowMessageHeader * System.Threading.Tasks.Dataflow.ITargetBlock<'Output> * bool -> 'Output

Public Function ConsumeMessage (messageHeader As DataflowMessageHeader, target As ITargetBlock(Of Out TOutput), ByRef messageConsumed As Boolean) As TOutput

パラメーター

messageHeader

DataflowMessageHeader

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

target

ITargetBlock<TOutput>

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

messageConsumed

Boolean

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

戻り値

TOutput

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

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

例外

ArgumentException

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

ArgumentNullException

ターゲットが null です。

注釈

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