ITargetBlock<TInput>.OfferMessage Méthode

Définition

Offre un message au ITargetBlock<TInput>, donnant à la cible la possibilité de consommer ou de reporter le 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

Paramètres

messageHeader
DataflowMessageHeader

Instance DataflowMessageHeader qui représente l’en-tête du message proposé.

messageValue
TInput

Valeur du message proposé.

source
ISourceBlock<TInput>

L’offre ISourceBlock<TOutput> du message. Il peut s’agir de null.

consumeToAccept
Boolean

Défini pour indiquer à true la cible d’appeler ConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>, Boolean) de manière synchrone pendant l’appel , OfferMessage(DataflowMessageHeader, TInput, ISourceBlock<TInput>, Boolean)avant de retourner Accepted, afin de consommer le message.

Retours

État du message proposé. Si le message a été accepté par la cible, Accepted est retourné et la source ne doit plus utiliser le message proposé, car il appartient maintenant à la cible. Si le message a été reporté par la cible, Postponed est retourné en tant que notification indiquant que la cible peut tenter ultérieurement de consommer ou de réserver le message ; en attendant, la source possède toujours le message et peut l’offrir à d’autres blocs.

Si la cible aurait autrement reporté le message, mais que la source était null, Declined est retournée à la place.

Si la cible a essayé d’accepter le message mais l’a manqué en raison de la source qui remet le message à une autre cible ou simplement de l’ignorer, NotAvailable est retournée.

Si la cible a choisi de ne pas accepter le message, Declined elle est retournée. Si la cible a choisi de ne pas accepter le message et n’acceptera jamais un autre message de cette source, DecliningPermanently est retourné.

Exceptions

L’objet messageHeader n’est pas valide.

-ou- consumeToAccept peut uniquement être vrai si fourni avec une valeur non null source.

S’applique à