Partilhar via


ISourceBlock<TOutput>.ConsumeMessage Método

Definição

Chamado por um ITargetBlock<TInput> vinculado para aceitar e consumir um DataflowMessageHeader anteriormente oferecido por este 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

Parâmetros

messageHeader
DataflowMessageHeader

O DataflowMessageHeader da mensagem que é consumida.

target
ITargetBlock<TOutput>

O ITargetBlock<TInput> que consome a mensagem.

messageConsumed
Boolean

true se a mensagem foi consumida com êxito; caso contrário, false.

Retornos

TOutput

O valor da mensagem consumida. Isso pode corresponder a uma instância DataflowMessageHeader diferente que foi reservada anteriormente e passada como o messageHeader para ConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>, Boolean). O ITargetBlock<TInput> de consumo deve usar o valor retornado em vez do valor passado como messageValue por meio de OfferMessage(DataflowMessageHeader, TInput, ISourceBlock<TInput>, Boolean).

Se a mensagem solicitada não estiver disponível, o valor retornado será nulo.

Exceções

O messageHeader não é válido.

O destino é null.

Comentários

Somente ITargetBlock<TInput> instâncias vinculadas a essa ISourceBlock<TOutput> instância podem usar ConsumeMessage, e ela só deve ser usada para consumir DataflowMessageHeader instâncias oferecidas anteriormente por essa origem para o destino.

Aplica-se a