Delen via

ServiceBusReceiverOptions interface

  • Referentie
Pakket:
@azure/service-bus

Opties die u kunt gebruiken bij het maken van een ontvanger.

Eigenschappen

identifier

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

De maximale duur, in milliseconden, dat de vergrendeling op het bericht automatisch wordt vernieuwd door de client. Deze automatische verlenging stopt zodra het bericht is vereffend.

  • Standaard-: 300 * 1000 milliseconden (5 minuten).
  • Als u de automatische verlenging vanwilt uitschakelen, stelt u dit in op 0.

voorbeeld:

Als de berichtvergrendeling binnen 2 minuten verloopt en de verwerkingstijd van het bericht 8 minuten is...

Stel maxAutoLockRenewalDurationInMs in op 10 minuten en de berichtvergrendeling wordt 4 keer automatisch vernieuwd (gelijk aan het vergrendelen van het bericht gedurende 4 keer de vergrendelingsduur door gebruik te maken van de verlengingen van de vergrendeling).
receiveMode

Vertegenwoordigt de ontvangstmodus voor de ontvanger.

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

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

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

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

Meer informatie over hoe peekLock en berichtafhandeling werkt hier: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate

Of u het converteren van het datumtype overslaat op eigenschappen van berichtaantekeningen of toepassingseigenschappen in getallen bij het ontvangen van het bericht. Standaard worden eigenschappen van het datumtype geconverteerd naar UNIX-epochnummer voor compatibiliteit.
skipParsingBodyAsJson

Optie om de client uit te schakelen voor het uitvoeren van JSON.parse() in de berichttekst wanneer het bericht wordt ontvangen. Niet van toepassing als het bericht is verzonden met de waarde of reeks van het hoofdteksttype AMQP. Gebruik deze optie als u liever rechtstreeks met de bytes in de berichttekst werkt dan dat de client deze probeert te parseren.
subQueueType

Vertegenwoordigt de subwachtrij die van toepassing is op een wachtrij of abonnement. Geldige waarden zijn 'deadLetter' en 'transferDeadLetter'. Zie https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues voor meer informatie over wachtrijen met dode letters

Eigenschapdetails

identifier

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

identifier?: string

Waarde van eigenschap

string

maxAutoLockRenewalDurationInMs

De maximale duur, in milliseconden, dat de vergrendeling op het bericht automatisch wordt vernieuwd door de client. Deze automatische verlenging stopt zodra het bericht is vereffend.

  • Standaard-: 300 * 1000 milliseconden (5 minuten).
  • Als u de automatische verlenging vanwilt uitschakelen, stelt u dit in op 0.

voorbeeld:

Als de berichtvergrendeling binnen 2 minuten verloopt en de verwerkingstijd van het bericht 8 minuten is...

Stel maxAutoLockRenewalDurationInMs in op 10 minuten en de berichtvergrendeling wordt 4 keer automatisch vernieuwd (gelijk aan het vergrendelen van het bericht gedurende 4 keer de vergrendelingsduur door gebruik te maken van de verlengingen van de vergrendeling).

maxAutoLockRenewalDurationInMs?: number

Waarde van eigenschap

number

receiveMode

Vertegenwoordigt de ontvangstmodus voor de ontvanger.

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

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

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

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

Meer informatie over hoe peekLock en berichtafhandeling werkt 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 overslaat op eigenschappen van berichtaantekeningen of toepassingseigenschappen in getallen bij het ontvangen van het bericht. Standaard worden eigenschappen van het datumtype geconverteerd naar UNIX-epochnummer voor compatibiliteit.

skipConvertingDate?: boolean

Waarde van eigenschap

boolean

skipParsingBodyAsJson

Optie om de client uit te schakelen voor het uitvoeren van JSON.parse() in de berichttekst wanneer het bericht wordt ontvangen. Niet van toepassing als het bericht is verzonden met de waarde of reeks van het hoofdteksttype AMQP. Gebruik deze optie als u liever rechtstreeks met de bytes in de berichttekst werkt dan dat de client deze probeert te parseren.

skipParsingBodyAsJson?: boolean

Waarde van eigenschap

boolean

subQueueType

Vertegenwoordigt de subwachtrij die van toepassing is op een wachtrij of abonnement. Geldige waarden zijn 'deadLetter' en 'transferDeadLetter'. Zie https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues voor meer informatie over wachtrijen met dode letters

subQueueType?: "deadLetter" | "transferDeadLetter"

Waarde van eigenschap

"deadLetter" | "transferDeadLetter"