ISourceBlock<TOutput>.ConsumeMessage Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Вызывается связанным объектом 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 -> 'OutputPublic 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.
Возвращаемое значение
Значение получаемого сообщения. Это может соответствовать другому экземпляру DataflowMessageHeader, отличному от ранее зарезервированного и переданного в качестве параметра messageHeader методу ConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>, Boolean). Рассматриваемый ITargetBlock<TInput> должен использовать возвращаемое значение вместо значения, переданного как параметр messageValue с помощью метода OfferMessage(DataflowMessageHeader, TInput, ISourceBlock<TInput>, Boolean).
Если запрашиваемое сообщение недоступно, возвращается значение NULL.
Исключения
Заголовок messageHeader является недопустимым.
Целевой объект null.
Комментарии
Только ITargetBlock<TInput> экземпляры, связанные с этим ISourceBlock<TOutput> экземпляром, могут использовать ConsumeMessage, и он должен использоваться только для использования DataflowMessageHeader экземпляров, ранее предложенных этим источником для целевого объекта.
