ServiceBusReceiverOptions interface

Balíček:

@azure/service-bus

Možnosti, které se mají použít při vytváření příjemce

Vlastnosti

identifier	Nastaví název pro identifikaci příjemce. Dá se použít ke korelaci protokolů a výjimek. Pokud není zadán nebo prázdný, použije se náhodný jedinečný.
maxAutoLockRenewalDurationInMs	Maximální doba trvání v milisekundách, po kterou se zámek zprávy automaticky obnoví klientem. Toto automatické prodlužování se zastaví, jakmile se zpráva vyrovná. výchozí : 300 * 1000 milisekundy (5 minut). Chcete-li zakázat automatické uzamčení, nastavte tuto možnost na 0. Příklad : Pokud zámek zprávy vyprší za 2 minuty a doba zpracování zprávy je 8 minut... Nastavte maxAutoLockRenewalDurationInMs na 10 minut a zámek zprávy se automaticky prodloužil po dobu 4krát (což odpovídá uzamčení zprávy po dobu 4krát jeho doby trvání uzamčení pomocí prodloužení zámku).
receiveMode	Představuje režim příjmu příjemce. V režimu receiveAndDelete se zprávy odstraní ze služby Service Bus při jejich přijetí. V režimu peekLock má příjemce zámek zprávy po dobu trvání uvedenou ve frontě nebo odběru. Zprávy, které nejsou v rámci doby trvání uzamčení vyřešeny, budou znovu předány tolikrát, kolikrát je maximální počet doručení nastavený ve frontě nebo předplatném, po kterém se odešlou do samostatné fronty nedoručených zpráv. Zprávu můžete vyřešit voláním metody complete(), abandon(), defer() nebo deadletter() ve zprávě. Další informace o fungování funkce PeekLock a vypořádání zpráv najdete tady: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	Zda se má při přijetí zprávy přeskočit převod typu datum u vlastností poznámek zpráv nebo vlastností aplikace na čísla. Ve výchozím nastavení se vlastnosti typu Date pro zajištění kompatibility převedou na epochové číslo systému UNIX.
skipParsingBodyAsJson	Možnost zakázat spuštění klienta JSON.parse() v textu zprávy při přijetí zprávy. Nelze použít, pokud byla zpráva odeslána s hodnotou nebo sekvencí typu textu AMQP. Tuto možnost použijte, pokud chcete pracovat přímo s bajty, které jsou přítomné v textu zprávy, než aby se klient pokusil parsovat.
subQueueType	Představuje dílčí frontu, která se vztahuje na jakoukoli frontu nebo předplatné. 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í zadán nebo prázdný, použije se náhodný jedinečný.

identifier?: string

Hodnota vlastnosti

string

maxAutoLockRenewalDurationInMs

Maximální doba trvání v milisekundách, po kterou se zámek zprávy automaticky obnoví klientem. Toto automatické prodlužování se zastaví, jakmile se zpráva vyrovná.

• výchozí : 300 * 1000 milisekundy (5 minut).
• Chcete-li zakázat automatické uzamčení, nastavte tuto možnost na 0.

Příklad :

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

Nastavte maxAutoLockRenewalDurationInMs na 10 minut a zámek zprávy se automaticky prodloužil po dobu 4krát (což odpovídá uzamčení zprávy po dobu 4krát jeho doby trvání uzamčení pomocí prodloužení zámku).

maxAutoLockRenewalDurationInMs?: number

Hodnota vlastnosti

number

receiveMode

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

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

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

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

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

Další informace o fungování funkce 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

Zda se má při přijetí zprávy přeskočit převod typu datum u vlastností poznámek zpráv nebo vlastností aplikace na čísla. Ve výchozím nastavení se vlastnosti typu Date pro zajištění kompatibility převedou na epochové číslo systému UNIX.

skipConvertingDate?: boolean

Hodnota vlastnosti

boolean

skipParsingBodyAsJson

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

skipParsingBodyAsJson?: boolean

Hodnota vlastnosti

boolean

subQueueType

Představuje dílčí frontu, která se vztahuje na jakoukoli frontu nebo předplatné. 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"