ITargetBlock<TInput>.OfferMessage Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Offre un message au ITargetBlock<TInput>, donnant à la cible la possibilité d'utiliser ou de différer 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 qui est proposé.
- messageValue
- TInput
Valeur du message proposé.
- source
- ISourceBlock<TInput>
ISourceBlock<TOutput> qui transmet le message. Il peut s'agir d'une valeur null.
- consumeToAccept
- Boolean
Définit sur true
pour indiquer à la cible d'appeler ConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>, Boolean) de façon synchrone pendant l'appel à OfferMessage(DataflowMessageHeader, TInput, ISourceBlock<TInput>, Boolean), avant de renvoyer Accepted pour utiliser 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 envoyé, car elle est désormais la propriété de la cible. Si le message a été différé par la cible, Postponed est retournée comme notification que la cible peut ensuite essayer d'utiliser ou de réserver un message ; parallèlement, la source possède le message et peut toujours le proposer à d'autres blocs.
Si la cible avait autrement différé le message alors que la source avait la valeur null
, Declined aurait été retourné à la place.
Si la cible a tenté de recevoir le message mais a échoué en raison de la source fournissant un message à une autre cible ou en l'ignorant simplement, NotAvailable est retourné.
Si la cible a choisi de ne pas recevoir le message, Declined est retourné. Si la cible a choisi de ne pas recevoir le message et ne recevra jamais un autre message de cette source, DecliningPermanently est retourné.
Exceptions
messageHeader
n'est pas valide.
ou consumeToAccept
peut avoir la valeur true uniquement s’il est fourni avec une source
non Null.