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 экземпляров, ранее предложенных этим источником для целевого объекта.

Применяется к