Dela via

ServiceBusReceiverOptions interface

  • Referens
Paket:
@azure/service-bus

Alternativ som ska användas när du skapar en mottagare.

Egenskaper

identifier

Anger namnet för att identifiera mottagaren. Detta kan användas för att korrelera loggar och undantag. Om det inte anges eller är tomt används en slumpmässig unik.
maxAutoLockRenewalDurationInMs

Den maximala varaktigheten, i millisekunder, att låset på meddelandet förnyas automatiskt av klienten. Den här automatiska förnyelsen stoppas när meddelandet har lösts.

  • Standard: 300 * 1000 millisekunder (5 minuter).
  • Om du vill inaktivera autolåsförnyelse anger du detta till 0.

Exempel:

Om meddelandelåset upphör att gälla om 2 minuter och bearbetningstiden för meddelandet är 8 minuter...

Ange maxAutoLockRenewalDurationInMs till 10 minuter, och meddelandelåset förnyas automatiskt i 4 gånger (vilket motsvarar att meddelandet är låst i 4 gånger låsets varaktighet genom att utnyttja låsförnyelserna).
receiveMode

Representerar mottagningsläget för mottagaren.

I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön/prenumerationen.

Meddelanden som inte har lösts inom låsets varaktighet levereras så många gånger som det maximala leveransantalet som angetts för kön/prenumerationen, varefter de skickas till en separat kö med obeställbara meddelanden.

Du kan lösa ett meddelande genom att anropa metoderna complete(), abandon(), defer() eller deadletter() i meddelandet.

Mer information om hur peekLock och meddelandeavräkning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate

Om du vill hoppa över konvertering av datumtyp på egenskaper för meddelandeanteckningar eller programegenskaper till tal när du tar emot meddelandet. Som standard konverteras egenskaperna för Datumtyp till UNIX-epoknummer för kompatibilitet.
skipParsingBodyAsJson

Alternativ för att inaktivera klienten från att köra JSON.parse() i meddelandetexten när meddelandet tas emot. Inte tillämpligt om meddelandet har skickats med värdet eller sekvensen av TYPEN AMQP-brödtext. Använd det här alternativet om du föredrar att arbeta direkt med byte som finns i meddelandetexten än om klienten försöker parsa dem.
subQueueType

Representerar den underkö som gäller för alla köer eller prenumerationer. Giltiga värden är "deadLetter" och "transferDeadLetter". Mer information om köer med obeställbara meddelanden finns i https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Egenskapsinformation

identifier

Anger namnet för att identifiera mottagaren. Detta kan användas för att korrelera loggar och undantag. Om det inte anges eller är tomt används en slumpmässig unik.

identifier?: string

Egenskapsvärde

string

maxAutoLockRenewalDurationInMs

Den maximala varaktigheten, i millisekunder, att låset på meddelandet förnyas automatiskt av klienten. Den här automatiska förnyelsen stoppas när meddelandet har lösts.

  • Standard: 300 * 1000 millisekunder (5 minuter).
  • Om du vill inaktivera autolåsförnyelse anger du detta till 0.

Exempel:

Om meddelandelåset upphör att gälla om 2 minuter och bearbetningstiden för meddelandet är 8 minuter...

Ange maxAutoLockRenewalDurationInMs till 10 minuter, och meddelandelåset förnyas automatiskt i 4 gånger (vilket motsvarar att meddelandet är låst i 4 gånger låsets varaktighet genom att utnyttja låsförnyelserna).

maxAutoLockRenewalDurationInMs?: number

Egenskapsvärde

number

receiveMode

Representerar mottagningsläget för mottagaren.

I läget receiveAndDelete tas meddelanden bort från Service Bus när de tas emot.

I peekLock-läge har mottagaren ett lås på meddelandet under den tid som anges i kön/prenumerationen.

Meddelanden som inte har lösts inom låsets varaktighet levereras så många gånger som det maximala leveransantalet som angetts för kön/prenumerationen, varefter de skickas till en separat kö med obeställbara meddelanden.

Du kan lösa ett meddelande genom att anropa metoderna complete(), abandon(), defer() eller deadletter() i meddelandet.

Mer information om hur peekLock och meddelandeavräkning fungerar här: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Egenskapsvärde

"peekLock" | "receiveAndDelete"

skipConvertingDate

Om du vill hoppa över konvertering av datumtyp på egenskaper för meddelandeanteckningar eller programegenskaper till tal när du tar emot meddelandet. Som standard konverteras egenskaperna för Datumtyp till UNIX-epoknummer för kompatibilitet.

skipConvertingDate?: boolean

Egenskapsvärde

boolean

skipParsingBodyAsJson

Alternativ för att inaktivera klienten från att köra JSON.parse() i meddelandetexten när meddelandet tas emot. Inte tillämpligt om meddelandet har skickats med värdet eller sekvensen av TYPEN AMQP-brödtext. Använd det här alternativet om du föredrar att arbeta direkt med byte som finns i meddelandetexten än om klienten försöker parsa dem.

skipParsingBodyAsJson?: boolean

Egenskapsvärde

boolean

subQueueType

Representerar den underkö som gäller för alla köer eller prenumerationer. Giltiga värden är "deadLetter" och "transferDeadLetter". Mer information om köer med obeställbara meddelanden finns i https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

subQueueType?: "deadLetter" | "transferDeadLetter"

Egenskapsvärde

"deadLetter" | "transferDeadLetter"