ITargetBlock<TInput>.OfferMessage Método

Referencia

Definición

Espacio de nombres:: System.Threading.Tasks.Dataflow

Ensamblado:: System.Threading.Tasks.Dataflow.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Ofrece un mensaje a ITargetBlock<TInput>, dando al destino la oportunidad de usar o de posponer el mensaje.

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

Parámetros

messageHeader: DataflowMessageHeader

Instancia de DataflowMessageHeader que representa el encabezado del mensaje que se va a ofrecer.

messageValue: TInput

Valor del mensaje que se va a ofrecer.

source: ISourceBlock<TInput>

ISourceBlock<TOutput> que ofrece el mensaje. Puede ser null.

consumeToAccept: Boolean

Establézcalo en true para indicar al destino para llamar a ConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>, Boolean) sincrónicamente durante la llamada a OfferMessage(DataflowMessageHeader, TInput, ISourceBlock<TInput>, Boolean), antes de devolver Accepted, para usar el mensaje.

Devoluciones

DataflowMessageStatus

Estado del mensaje ofrecido. Si el destino aceptó el mensaje, se devuelve Accepted y el origen ya no debe usar más el mensaje ofrecido, ya que ahora es propiedad del destino. Si el destino pospuso el mensaje, se devuelve Postponed como notificación de que el destino puede intentar más adelante consumir o reservar el mensaje; mientras tanto, el origen todavía posee el mensaje y puede ofrecerlo a otros bloques.

Si el destino hubiera pospuesto de otra forma el mensaje, pero el origen fuera null, se devuelve Declined en su lugar.

Si el destino intentó aceptar el mensaje pero no pudo hacerlo porque el origen entrega el mensaje a otro destino o lo descarta simplemente, se devuelve NotAvailable.

Si el destino eligió no aceptar el mensaje, se devuelve Declined. Si el destino eligió no aceptar el mensaje y nunca aceptará otro mensaje de este origen, se devuelve DecliningPermanently.

Excepciones

ArgumentException

messageHeader no es válido.

O bien, consumeToAccept solo puede ser true si se le proporciona un valor source distinto de NULL.

Se aplica a