Sdílet prostřednictvím

ServiceBusReceiverOptions interface

  • Reference
Balíček:
@azure/service-bus

Možnosti, které se mají použít při vytváření přijímače.

Vlastnosti

identifier

Nastaví název pro identifikaci příjemce. Dá se použít ke korelaci protokolů a výjimek. Pokud není zadaný nebo prázdný, použije se náhodný jedinečný parametr.
maxAutoLockRenewalDurationInMs

Maximální doba trvání (v milisekundách), po kterou bude uzamčení zprávy klientem automaticky obnoveno. Toto automatické prodlužování platnosti se zastaví, jakmile je zpráva vyřešena.

  • Výchozí hodnota: 300 * 1000 milisekundy (5 minut).
  • Pokud chcete automatické uzamčení zakázat, nastavte ho na 0.

Příklad:

Pokud zámek zpráv vyprší za 2 minuty a doba zpracování zprávy je 8 minut...

Nastavte hodnotu maxAutoLockRenewalDurationInMs na 10 minut a zámek zprávy se automaticky prodloužil na 4krát (což odpovídá tomu, že se zpráva uzamkne po dobu 4násobku doby trvání zámku pomocí prodloužení platnosti zámku).
receiveMode

Představuje režim příjmu pro příjemce.

V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí.

V režimu peekLock má příjemce u zprávy zámek po dobu uvedenou ve frontě nebo odběru.

Zprávy, které nejsou vyřešené v rámci doby trvání zámku, budou znovu odeslány tolikrát, kolikrát je nastavený maximální počet doručení ve frontě nebo předplatném, a potom se odešlou do samostatné fronty nedoručených zpráv.

Zprávu můžete vyřešit voláním metod complete(), abandon(), defer() nebo deadletter() ve zprávě.

Další informace o tom, jak funguje peekLock a vypořádání zpráv, najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate

Jestli se má při přijetí zprávy přeskočit převod typu Datum u vlastností poznámek ke zprávě nebo vlastností aplikace na čísla. Ve výchozím nastavení jsou vlastnosti typu Date z důvodu kompatibility převedeny na epochové číslo systému UNIX.
skipParsingBodyAsJson

Možnost zakázat klientovi spouštění JSON.parse() v textu zprávy při příjmu zprávy. Nelze použít, pokud byla zpráva odeslána s hodnotou nebo posloupností typu textu AMQP. Tuto možnost použijte, pokud chcete pracovat přímo s bajty, které jsou v textu zprávy, než aby se je klient pokusil analyzovat.
subQueueType

Představuje pod frontu, která je použitelná pro všechny fronty nebo odběry. Platné hodnoty jsou "deadLetter" a "transferDeadLetter". Další informace o frontách nedoručených zpráv najdete v tématu https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Podrobnosti vlastnosti

identifier

Nastaví název pro identifikaci příjemce. Dá se použít ke korelaci protokolů a výjimek. Pokud není zadaný nebo prázdný, použije se náhodný jedinečný parametr.

identifier?: string

Hodnota vlastnosti

string

maxAutoLockRenewalDurationInMs

Maximální doba trvání (v milisekundách), po kterou bude uzamčení zprávy klientem automaticky obnoveno. Toto automatické prodlužování platnosti se zastaví, jakmile je zpráva vyřešena.

  • Výchozí hodnota: 300 * 1000 milisekundy (5 minut).
  • Pokud chcete automatické uzamčení zakázat, nastavte ho na 0.

Příklad:

Pokud zámek zpráv vyprší za 2 minuty a doba zpracování zprávy je 8 minut...

Nastavte hodnotu maxAutoLockRenewalDurationInMs na 10 minut a zámek zprávy se automaticky prodloužil na 4krát (což odpovídá tomu, že se zpráva uzamkne po dobu 4násobku doby trvání zámku pomocí prodloužení platnosti zámku).

maxAutoLockRenewalDurationInMs?: number

Hodnota vlastnosti

number

receiveMode

Představuje režim příjmu pro příjemce.

V režimu receiveAndDelete se zprávy ze služby Service Bus odstraňují při jejich přijetí.

V režimu peekLock má příjemce u zprávy zámek po dobu uvedenou ve frontě nebo odběru.

Zprávy, které nejsou vyřešené v rámci doby trvání zámku, budou znovu odeslány tolikrát, kolikrát je nastavený maximální počet doručení ve frontě nebo předplatném, a potom se odešlou do samostatné fronty nedoručených zpráv.

Zprávu můžete vyřešit voláním metod complete(), abandon(), defer() nebo deadletter() ve zprávě.

Další informace o tom, jak funguje peekLock a vypořádání zpráv, najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Hodnota vlastnosti

"peekLock" | "receiveAndDelete"

skipConvertingDate

Jestli se má při přijetí zprávy přeskočit převod typu Datum u vlastností poznámek ke zprávě nebo vlastností aplikace na čísla. Ve výchozím nastavení jsou vlastnosti typu Date z důvodu kompatibility převedeny na epochové číslo systému UNIX.

skipConvertingDate?: boolean

Hodnota vlastnosti

boolean

skipParsingBodyAsJson

Možnost zakázat klientovi spouštění JSON.parse() v textu zprávy při příjmu zprávy. Nelze použít, pokud byla zpráva odeslána s hodnotou nebo posloupností typu textu AMQP. Tuto možnost použijte, pokud chcete pracovat přímo s bajty, které jsou v textu zprávy, než aby se je klient pokusil analyzovat.

skipParsingBodyAsJson?: boolean

Hodnota vlastnosti

boolean

subQueueType

Představuje pod frontu, která je použitelná pro všechny fronty nebo odběry. Platné hodnoty jsou "deadLetter" a "transferDeadLetter". Další informace o frontách nedoručených zpráv najdete v tématu https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

subQueueType?: "deadLetter" | "transferDeadLetter"

Hodnota vlastnosti

"deadLetter" | "transferDeadLetter"