ServiceBusReceiverOptions interface

Pacchetto:

@azure/service-bus

Opzioni da usare per la creazione di un ricevitore.

Proprietà

identifier	Imposta il nome per identificare il ricevitore. Può essere usato per correlare log ed eccezioni. Se non specificato o vuoto, verrà usato un valore univoco casuale.
maxAutoLockRenewalDurationInMs	Durata massima, in millisecondi, che il blocco sul messaggio verrà rinnovato automaticamente dal client. Questo rinnovo automatico si interrompe una volta stabilito il messaggio. predefinita: 300 * 1000 millisecondi (5 minuti). Per disabilitare il rinnovo automatico, impostarlo su 0. Esempio di : Se il blocco del messaggio scade in 2 minuti e il tempo di elaborazione del messaggio è di 8 minuti... Impostare maxAutoLockRenewalDurationInMs su 10 minuti e il blocco del messaggio verrà rinnovato automaticamente per 4 volte (equivale ad avere bloccato il messaggio per 4 volte la durata del blocco sfruttando i rinnovi del blocco).
receiveMode	Rappresenta la modalità di ricezione per il ricevitore. In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti. In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda o nella sottoscrizione. I messaggi che non vengono risolti entro la durata del blocco verranno recapitati ogni volta che il numero massimo di recapito impostato nella coda o nella sottoscrizione, dopo il quale vengono inviati a una coda di messaggi non recapitabili separata. È possibile risolvere un messaggio chiamando i metodi complete(), abandon(), defer() o deadletter() nel messaggio. Altre informazioni sul funzionamento di peekLock e message settlement sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	Indica se ignorare la conversione del tipo Date nelle proprietà delle annotazioni dei messaggi o delle proprietà dell'applicazione in numeri durante la ricezione del messaggio. Per impostazione predefinita, le proprietà di tipo Date vengono convertite in numeri di epoca UNIX per la compatibilità.
skipParsingBodyAsJson	Opzione per disabilitare il client dall'esecuzione di JSON.parse() nel corpo del messaggio durante la ricezione del messaggio. Non applicabile se il messaggio è stato inviato con il valore o la sequenza del tipo di corpo AMQP. Usare questa opzione quando si preferisce lavorare direttamente con i byte presenti nel corpo del messaggio rispetto al tentativo del client di analizzarlo.
subQueueType	Rappresenta la coda secondaria applicabile per qualsiasi coda o sottoscrizione. I valori validi sono "deadLetter" e "transferDeadLetter". Per altre informazioni sulle code di messaggi non recapitabili, vedere https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Dettagli proprietà

identifier

Imposta il nome per identificare il ricevitore. Può essere usato per correlare log ed eccezioni. Se non specificato o vuoto, verrà usato un valore univoco casuale.

identifier?: string

Valore della proprietà

string

maxAutoLockRenewalDurationInMs

Durata massima, in millisecondi, che il blocco sul messaggio verrà rinnovato automaticamente dal client. Questo rinnovo automatico si interrompe una volta stabilito il messaggio.

• predefinita: 300 * 1000 millisecondi (5 minuti).
• Per disabilitare il rinnovo automatico, impostarlo su 0.

Esempio di :

Se il blocco del messaggio scade in 2 minuti e il tempo di elaborazione del messaggio è di 8 minuti...

Impostare maxAutoLockRenewalDurationInMs su 10 minuti e il blocco del messaggio verrà rinnovato automaticamente per 4 volte (equivale ad avere bloccato il messaggio per 4 volte la durata del blocco sfruttando i rinnovi del blocco).

maxAutoLockRenewalDurationInMs?: number

Valore della proprietà

number

receiveMode

Rappresenta la modalità di ricezione per il ricevitore.

In modalità receiveAndDelete i messaggi vengono eliminati dal bus di servizio man mano che vengono ricevuti.

In modalità peekLock il ricevitore ha un blocco sul messaggio per la durata specificata nella coda o nella sottoscrizione.

I messaggi che non vengono risolti entro la durata del blocco verranno recapitati ogni volta che il numero massimo di recapito impostato nella coda o nella sottoscrizione, dopo il quale vengono inviati a una coda di messaggi non recapitabili separata.

È possibile risolvere un messaggio chiamando i metodi complete(), abandon(), defer() o deadletter() nel messaggio.

Altre informazioni sul funzionamento di peekLock e message settlement sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Valore della proprietà

"peekLock" | "receiveAndDelete"

skipConvertingDate

Indica se ignorare la conversione del tipo Date nelle proprietà delle annotazioni dei messaggi o delle proprietà dell'applicazione in numeri durante la ricezione del messaggio. Per impostazione predefinita, le proprietà di tipo Date vengono convertite in numeri di epoca UNIX per la compatibilità.

skipConvertingDate?: boolean

Valore della proprietà

boolean

skipParsingBodyAsJson

Opzione per disabilitare il client dall'esecuzione di JSON.parse() nel corpo del messaggio durante la ricezione del messaggio. Non applicabile se il messaggio è stato inviato con il valore o la sequenza del tipo di corpo AMQP. Usare questa opzione quando si preferisce lavorare direttamente con i byte presenti nel corpo del messaggio rispetto al tentativo del client di analizzarlo.

skipParsingBodyAsJson?: boolean

Valore della proprietà

boolean

subQueueType

Rappresenta la coda secondaria applicabile per qualsiasi coda o sottoscrizione. I valori validi sono "deadLetter" e "transferDeadLetter". Per altre informazioni sulle code di messaggi non recapitabili, vedere https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

subQueueType?: "deadLetter" | "transferDeadLetter"

Valore della proprietà

"deadLetter" | "transferDeadLetter"