Sdílet prostřednictvím

ServiceBusSessionReceiverOptions interface

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

Popisuje možnosti předávané metodám acceptSession a acceptNextSession při použití fronty nebo předplatného s povolenými relacemi.

Extends
OperationOptionsBase

Vlastnosti

identifier

Nastaví název pro identifikaci příjemce relace. 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 v milisekundách, po kterou klient automaticky prodloužil zámek relace.

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

Příklad:

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

Nastavte hodnotu maxAutoLockRenewalDurationInMs na 10 minut a zámek se automaticky prodlouží asi 4krát (což odpovídá tomu, že se relace uzamkne po dobu 4násobku doby trvání zámku využitím obnovení zámku).
receiveMode

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

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

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

Zprávy, které nejsou vyřešené během doby trvání uzamčení, budou předepisovány tolikrát, kolikrát je maximální počet doručení nastavený 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 chcete při příjmu zprávy přeskočit převod typu Datum u vlastností poznámek zprávy 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řijetí zprávy Nelze použít, pokud se zpráva odeslala 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 ho klient pokusil analyzovat.

Zděděné vlastnosti

abortSignal

Signál, který lze použít k přerušení požadavků.
tracingOptions

Možnosti použité při povoleném trasování

Podrobnosti vlastnosti

identifier

Nastaví název pro identifikaci příjemce relace. 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 v milisekundách, po kterou klient automaticky prodloužil zámek relace.

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

Příklad:

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

Nastavte hodnotu maxAutoLockRenewalDurationInMs na 10 minut a zámek se automaticky prodlouží asi 4krát (což odpovídá tomu, že se relace uzamkne po dobu 4násobku doby trvání zámku využitím obnovení zámku).

maxAutoLockRenewalDurationInMs?: number

Hodnota vlastnosti

number

receiveMode

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

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

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

Zprávy, které nejsou vyřešené během doby trvání uzamčení, budou předepisovány tolikrát, kolikrát je maximální počet doručení nastavený 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 chcete při příjmu zprávy přeskočit převod typu Datum u vlastností poznámek zprávy 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řijetí zprávy Nelze použít, pokud se zpráva odeslala 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 ho klient pokusil analyzovat.

skipParsingBodyAsJson?: boolean

Hodnota vlastnosti

boolean

Podrobnosti zděděných vlastností

abortSignal

Signál, který lze použít k přerušení požadavků.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

Zděděno z OperationOptionsBase.abortSignal

tracingOptions

Možnosti použité při povoleném trasování

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

Zděděno z OperationOptionsBase.tracingOptions