Edit

ITargetBlock<TInput>.OfferMessage Method

  • Reference

Definition

Namespace:
System.Threading.Tasks.Dataflow
Assembly:
System.Threading.Tasks.Dataflow.dll

Offers a message to the ITargetBlock<TInput>, giving the target the opportunity to consume or postpone the message.

public System.Threading.Tasks.Dataflow.DataflowMessageStatus OfferMessage (System.Threading.Tasks.Dataflow.DataflowMessageHeader messageHeader, TInput messageValue, System.Threading.Tasks.Dataflow.ISourceBlock<in TInput> source, bool consumeToAccept);
public System.Threading.Tasks.Dataflow.DataflowMessageStatus OfferMessage (System.Threading.Tasks.Dataflow.DataflowMessageHeader messageHeader, TInput messageValue, System.Threading.Tasks.Dataflow.ISourceBlock<in TInput>? source, bool consumeToAccept);
abstract member OfferMessage : System.Threading.Tasks.Dataflow.DataflowMessageHeader * 'Input * System.Threading.Tasks.Dataflow.ISourceBlock<'Input> * bool -> System.Threading.Tasks.Dataflow.DataflowMessageStatus
Public Function OfferMessage (messageHeader As DataflowMessageHeader, messageValue As TInput, source As ISourceBlock(Of In TInput), consumeToAccept As Boolean) As DataflowMessageStatus

Parameters

messageHeader
DataflowMessageHeader

A DataflowMessageHeader instance that represents the header of the message being offered.

messageValue
TInput

The value of the message being offered.

source
ISourceBlock<TInput>

The ISourceBlock<TOutput> offering the message. This may be null.

consumeToAccept
Boolean

Set to true to instruct the target to call ConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>, Boolean) synchronously during the call to OfferMessage(DataflowMessageHeader, TInput, ISourceBlock<TInput>, Boolean), prior to returning Accepted, in order to consume the message.

Returns

DataflowMessageStatus

The status of the offered message. If the message was accepted by the target, Accepted is returned, and the source should no longer use the offered message, because it is now owned by the target. If the message was postponed by the target, Postponed is returned as a notification that the target may later attempt to consume or reserve the message; in the meantime, the source still owns the message and may offer it to other blocks.

If the target would have otherwise postponed message, but source was null, Declined is instead returned.

If the target tried to accept the message but missed it due to the source delivering the message to another target or simply discarding it, NotAvailable is returned.

If the target chose not to accept the message, Declined is returned. If the target chose not to accept the message and will never accept another message from this source, DecliningPermanently is returned.

Exceptions

ArgumentException

The messageHeader is not valid.

-or- consumeToAccept may only be true if provided with a non-null source.

Applies to