BufferBlock<T>.ISourceBlock<T>.ConsumeMessage 方法

定义

命名空间:

System.Threading.Tasks.Dataflow

程序集:

System.Threading.Tasks.Dataflow.dll

Source:

BufferBlock.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。

注解

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