ServiceBusSessionReceiverOptions interface

Pacchetto:

@azure/service-bus

Vengono descritte le opzioni passate ai acceptSession metodi e acceptNextSession quando si usa una coda/sottoscrizione con sessioni abilitate.

Extends

OperationOptionsBase

Proprietà

identifier	Imposta il nome per identificare il ricevitore della sessione. Può essere usato per correlare log ed eccezioni. Se non specificato o vuoto, verrà usato un univoco casuale.
maxAutoLockRenewalDurationInMs	Durata massima, in millisecondi, che il blocco sulla sessione verrà rinnovato automaticamente dal client. Impostazione predefinita: 300000 millisecondi (5 minuti). Per disabilitare il rinnovo del blocco automatico, impostare su 0. Esempio: Se il blocco scade tra 2 minuti e il tempo di elaborazione è di 8 minuti... Impostare maxAutoLockRenewalDurationInMs su 10 minuti e il blocco verrà rinnovato automaticamente circa 4 volte (equivale ad avere la sessione bloccata 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 quando 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 tutte le volte in cui il numero massimo di recapito impostato nella coda o nella sottoscrizione, dopo il quale vengono inviati a una coda separata di messaggi non recapitabili. È possibile risolvere un messaggio chiamando i metodi complete(), abandon(), defer() o deadletter() nel messaggio. Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi sono disponibili qui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	Se ignorare la conversione del tipo Date nelle proprietà delle annotazioni del messaggio o delle proprietà dell'applicazione in numeri durante la ricezione del messaggio. Per impostazione predefinita, le proprietà del tipo Date vengono convertite in un numero di periodo UNIX per la compatibilità.
skipParsingBodyAsJson	Opzione per disabilitare l'esecuzione del client 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 usare direttamente i byte presenti nel corpo del messaggio rispetto al tentativo del client di analizzarlo.

Proprietà ereditate

abortSignal	Segnale che può essere usato per interrompere le richieste.
tracingOptions	Opzioni utilizzate quando la traccia è abilitata.

Dettagli proprietà

identifier

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

identifier?: string

Valore della proprietà

string

maxAutoLockRenewalDurationInMs

Durata massima, in millisecondi, che il blocco sulla sessione verrà rinnovato automaticamente dal client.

• Impostazione predefinita: 300000 millisecondi (5 minuti).
• Per disabilitare il rinnovo del blocco automatico, impostare su 0.

Esempio:

Se il blocco scade tra 2 minuti e il tempo di elaborazione è di 8 minuti...

Impostare maxAutoLockRenewalDurationInMs su 10 minuti e il blocco verrà rinnovato automaticamente circa 4 volte (equivale ad avere la sessione bloccata 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 quando 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 tutte le volte in cui il numero massimo di recapito impostato nella coda o nella sottoscrizione, dopo il quale vengono inviati a una coda separata di messaggi non recapitabili.

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

Altre informazioni sul funzionamento di peekLock e risoluzione dei messaggi 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

Se ignorare la conversione del tipo Date nelle proprietà delle annotazioni del messaggio o delle proprietà dell'applicazione in numeri durante la ricezione del messaggio. Per impostazione predefinita, le proprietà del tipo Date vengono convertite in un numero di periodo UNIX per la compatibilità.

skipConvertingDate?: boolean

Valore della proprietà

boolean

skipParsingBodyAsJson

Opzione per disabilitare l'esecuzione del client 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 usare direttamente i byte presenti nel corpo del messaggio rispetto al tentativo del client di analizzarlo.

skipParsingBodyAsJson?: boolean

Valore della proprietà

boolean

Dettagli proprietà ereditate

abortSignal

Segnale che può essere usato per interrompere le richieste.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

Ereditato da OperationOptionsBase.abortSignal

tracingOptions

Opzioni utilizzate quando la traccia è abilitata.

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

Ereditato da OperationOptionsBase.tracingOptions