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);

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>必須使用傳回的值，而不是使用做為 messageValue 經 OfferMessage(DataflowMessageHeader, TInput, ISourceBlock<TInput>, Boolean) 傳送的值。

如果無法取得要求的訊息，傳回值會是 null。

例外狀況

ArgumentException

messageHeader 無效。

ArgumentNullException

目標是 null。

備註

只有 ITargetBlock<TInput> 連結至這個 ISourceBlock<TOutput> 實例的實例可以使用 ConsumeMessage ，而且它只能用來取 DataflowMessageHeader 用此來源先前提供給目標的實例。