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> 必须使用返回值而不是通过 OfferMessage(DataflowMessageHeader, TInput, ISourceBlock<TInput>, Boolean) 传递为 messageValue 的值。

如果所请求的消息不可用，则返回值将是 null。

例外

ArgumentException

MessageHeader 无效。

ArgumentNullException

目标是 null。

注解

只有 ITargetBlock<TInput> 链接到此 ISourceBlock<TOutput> 实例的实例可以使用 ConsumeMessage，并且它只能用于使用此 DataflowMessageHeader 源以前提供给目标的实例。