ServiceBusMessageBatch interface

Pacchetto:

@azure/service-bus

Un batch di messaggi che è possibile creare usando il metodo <xref:createBatch>.

Proprietà

count	Numero di messaggi aggiunti al batch.
maxSizeInBytes	Dimensioni massime del batch, in byte. La funzione tryAddMessage nel batch restituirà false se il messaggio aggiunto causa il superamento di questo limite per le dimensioni del batch. Utilizzare il metodo createMessageBatch() nel Sender per impostare maxSizeInBytes.
sizeInBytes	Dimensioni del batch in byte dopo che gli eventi aggiunti sono stati codificati in un singolo messaggio AMQP.

Metodi

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Aggiunge un messaggio al batch, se consentito dal limite di dimensioni del batch. NOTA: ricordarsi sempre di controllare il valore restituito di questo metodo, prima di chiamarlo di nuovo per l'evento successivo.

Dettagli proprietà

count

Numero di messaggi aggiunti al batch.

count: number

Valore della proprietà

number

maxSizeInBytes

Dimensioni massime del batch, in byte. La funzione tryAddMessage nel batch restituirà false se il messaggio aggiunto causa il superamento di questo limite per le dimensioni del batch. Utilizzare il metodo createMessageBatch() nel Sender per impostare maxSizeInBytes.

maxSizeInBytes: number

Valore della proprietà

number

sizeInBytes

Dimensioni del batch in byte dopo che gli eventi aggiunti sono stati codificati in un singolo messaggio AMQP.

sizeInBytes: number

Valore della proprietà

number

Dettagli metodo

tryAddMessage(ServiceBusMessage | AmqpAnnotatedMessage, TryAddOptions)

Aggiunge un messaggio al batch, se consentito dal limite di dimensioni del batch. NOTA: ricordarsi sempre di controllare il valore restituito di questo metodo, prima di chiamarlo di nuovo per l'evento successivo.

function tryAddMessage(message: ServiceBusMessage | AmqpAnnotatedMessage, options?: TryAddOptions): boolean

Parametri

message

ServiceBusMessage | AmqpAnnotatedMessage

Messaggio da aggiungere al batch.

options

TryAddOptions

Restituisce

boolean

Valore booleano che indica se il messaggio è stato aggiunto al batch o meno.