ISourceBlock<TOutput>.ConsumeMessage Método

Definição

Chamado por um link ITargetBlock<TInput> 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);
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

A DataflowMessageHeader da mensagem a ser consumida.

target
ITargetBlock<TOutput>

A ITargetBlock<TInput> absorver a mensagem.

messageConsumed
Boolean

true se a mensagem fosse consumida com sucesso; caso contrário, false.

Devoluções

TOutput

O valor da mensagem consumida. Isto pode corresponder a uma instância diferente DataflowMessageHeader daquela que foi anteriormente reservada e passada como para messageHeaderConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>, Boolean). O consumidor ITargetBlock<TInput> deve usar o valor devolvido em vez do valor passado como messageValue passando por OfferMessage(DataflowMessageHeader, TInput, ISourceBlock<TInput>, Boolean).

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

Exceções

O messageHeader não é válido.

O alvo é null.

Observações

Apenas ITargetBlock<TInput> as instâncias ligadas a esta ISourceBlock<TOutput> instância podem usar ConsumeMessage, e ela só deve ser usada para consumir DataflowMessageHeader instâncias anteriormente oferecidas por esta fonte ao alvo.

Aplica-se a