ServiceBusSessionReceiverOptions interface

Pakket:

@azure/service-bus

Hierin worden de opties beschreven die worden doorgegeven aan de acceptSession methoden en acceptNextSession bij het gebruik van een wachtrij/abonnement waarvoor sessies zijn ingeschakeld.

Uitbreiding

OperationOptionsBase

Eigenschappen

identifier	Hiermee stelt u de naam in om de sessieontvanger te identificeren. Dit kan worden gebruikt om logboeken en uitzonderingen te correleren. Als dit niet is opgegeven of leeg is, wordt een willekeurige unieke gebruikt.
maxAutoLockRenewalDurationInMs	De maximale duur, in milliseconden, dat de vergrendeling van de sessie automatisch wordt vernieuwd door de client. Standaard: 300000 milliseconden (5 minuten). Als u automatische verlenging wilt uitschakelen, stelt u dit in op 0. Voorbeeld: Als de vergrendeling over 2 minuten verloopt en uw verwerkingstijd 8 minuten is... Stel maxAutoLockRenewalDurationInMs in op 10 minuten en de vergrendeling wordt automatisch ongeveer vier keer vernieuwd (equivalent aan het vergrendelen van de sessie gedurende 4 keer de vergrendelingsduur door gebruik te maken van de vergrendelingsvernieuwingen).
receiveMode	Vertegenwoordigt de ontvangstmodus voor de ontvanger. In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen. In de peekLock-modus heeft de ontvanger een vergrendeling voor het bericht voor de duur die is opgegeven voor de wachtrij/het abonnement. Berichten die niet binnen de vergrendelingsduur zijn vereffend, worden net zo vaak opnieuw bezorgd als het maximale aantal bezorgingen dat is ingesteld voor de wachtrij/het abonnement, waarna ze naar een afzonderlijke wachtrij met onbestelbare berichten worden verzonden. U kunt een bericht vereffenen door de methoden complete(), abandon(), defer() of deadletter() aan te roepen voor het bericht. Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	Of u het converteren van het datumtype voor eigenschappen van berichtaantekeningen of toepassingseigenschappen naar getallen wilt overslaan wanneer u het bericht ontvangt. Standaard worden eigenschappen van datumtype geconverteerd naar UNIX-epochenummer voor compatibiliteit.
skipParsingBodyAsJson	Optie om uit te schakelen dat de client JSON.parse() uitvoert op de hoofdtekst van het bericht wanneer het bericht wordt ontvangen. Niet van toepassing als het bericht is verzonden met de amqp-hoofdtekst of -volgorde. Gebruik deze optie als u liever rechtstreeks werkt met de bytes die aanwezig zijn in de berichttekst dan dat de client deze probeert te parseren.

Overgenomen eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
tracingOptions	Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

identifier

Hiermee stelt u de naam in om de sessieontvanger te identificeren. Dit kan worden gebruikt om logboeken en uitzonderingen te correleren. Als dit niet is opgegeven of leeg is, wordt een willekeurige unieke gebruikt.

identifier?: string

Waarde van eigenschap

string

maxAutoLockRenewalDurationInMs

De maximale duur, in milliseconden, dat de vergrendeling van de sessie automatisch wordt vernieuwd door de client.

• Standaard: 300000 milliseconden (5 minuten).
• Als u automatische verlenging wilt uitschakelen, stelt u dit in op 0.

Voorbeeld:

Als de vergrendeling over 2 minuten verloopt en uw verwerkingstijd 8 minuten is...

Stel maxAutoLockRenewalDurationInMs in op 10 minuten en de vergrendeling wordt automatisch ongeveer vier keer vernieuwd (equivalent aan het vergrendelen van de sessie gedurende 4 keer de vergrendelingsduur door gebruik te maken van de vergrendelingsvernieuwingen).

maxAutoLockRenewalDurationInMs?: number

Waarde van eigenschap

number

receiveMode

Vertegenwoordigt de ontvangstmodus voor de ontvanger.

In de receiveAndDelete-modus worden berichten verwijderd uit Service Bus zodra ze worden ontvangen.

In de peekLock-modus heeft de ontvanger een vergrendeling voor het bericht voor de duur die is opgegeven voor de wachtrij/het abonnement.

Berichten die niet binnen de vergrendelingsduur zijn vereffend, worden net zo vaak opnieuw bezorgd als het maximale aantal bezorgingen dat is ingesteld voor de wachtrij/het abonnement, waarna ze naar een afzonderlijke wachtrij met onbestelbare berichten worden verzonden.

U kunt een bericht vereffenen door de methoden complete(), abandon(), defer() of deadletter() aan te roepen voor het bericht.

Meer informatie over de werking van peekLock en berichtafhandeling vindt u hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Waarde van eigenschap

"peekLock" | "receiveAndDelete"

skipConvertingDate

Of u het converteren van het datumtype voor eigenschappen van berichtaantekeningen of toepassingseigenschappen naar getallen wilt overslaan wanneer u het bericht ontvangt. Standaard worden eigenschappen van datumtype geconverteerd naar UNIX-epochenummer voor compatibiliteit.

skipConvertingDate?: boolean

Waarde van eigenschap

boolean

skipParsingBodyAsJson

Optie om uit te schakelen dat de client JSON.parse() uitvoert op de hoofdtekst van het bericht wanneer het bericht wordt ontvangen. Niet van toepassing als het bericht is verzonden met de amqp-hoofdtekst of -volgorde. Gebruik deze optie als u liever rechtstreeks werkt met de bytes die aanwezig zijn in de berichttekst dan dat de client deze probeert te parseren.

skipParsingBodyAsJson?: boolean

Waarde van eigenschap

boolean

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

Overgenomen van OperationOptionsBase.abortSignal

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

Overgenomen van OperationOptionsBase.tracingOptions