Udostępnij za pośrednictwem

ServiceBusSessionReceiverOptions interface

  • Odwołanie
Pakiet:
@azure/service-bus

Opisuje opcje przekazywane do acceptSession metod i acceptNextSession podczas korzystania z kolejki/subskrypcji z włączonymi sesjami.

Extends
OperationOptionsBase

Właściwości

identifier

Ustawia nazwę, aby zidentyfikować odbiornik sesji. Może to służyć do korelowania dzienników i wyjątków. Jeśli nie zostanie określony lub pusty, zostanie użyty losowy unikatowy.
maxAutoLockRenewalDurationInMs

Maksymalny czas trwania ( w milisekundach), że blokada w sesji zostanie automatycznie odnowiona przez klienta.

  • Ustawienie domyślne: 300000 milisekundy (5 minut).
  • Aby wyłączyć odnawianie automatycznego blokady, ustaw wartość 0.

Przykład:

Jeśli blokada wygaśnie w ciągu 2 minut, a czas przetwarzania wynosi 8 minut...

Ustaw wartość maxAutoLockRenewalDurationInMs na 10 minut, a blokada zostanie automatycznie odnowiona około 4 razy (co odpowiada zablokowaniu sesji przez 4 razy jej czas trwania blokady przy użyciu odnawiania blokady).
receiveMode

Reprezentuje tryb odbierania dla odbiornika.

W trybie odbieraniaAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania.

W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce/subskrypcji.

Komunikaty, które nie są rozliczane w ramach czasu trwania blokady, będą ponownie dostarczane tyle razy, ile maksymalna liczba dostaw ustawiona w kolejce/subskrypcji, po której będą wysyłane do oddzielnej kolejki utraconych wiadomości.

Komunikat można rozstrzygnąć, wywołując metody complete(), abandon(), defer() lub deadletter().

Więcej informacji na temat sposobu działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate

Czy pominąć konwertowanie typu daty we właściwościach adnotacji komunikatów lub właściwości aplikacji na liczby podczas odbierania komunikatu. Domyślnie właściwości typu Data są konwertowane na numer epoki SYSTEMU UNIX w celu zapewnienia zgodności.
skipParsingBodyAsJson

Opcja wyłączenia klienta z uruchamiania pliku JSON.parse() w treści komunikatu podczas odbierania komunikatu. Nie dotyczy, jeśli wiadomość została wysłana z wartością typu treści amQP lub sekwencją. Użyj tej opcji, jeśli wolisz pracować bezpośrednio z bajtami obecnymi w treści komunikatu niż klient próbuje go przeanalizować.

Właściwości dziedziczone

abortSignal

Sygnał, który może służyć do przerwania żądań.
tracingOptions

Opcje używane podczas śledzenia są włączone.

Szczegóły właściwości

identifier

Ustawia nazwę, aby zidentyfikować odbiornik sesji. Może to służyć do korelowania dzienników i wyjątków. Jeśli nie zostanie określony lub pusty, zostanie użyty losowy unikatowy.

identifier?: string

Wartość właściwości

string

maxAutoLockRenewalDurationInMs

Maksymalny czas trwania ( w milisekundach), że blokada w sesji zostanie automatycznie odnowiona przez klienta.

  • Ustawienie domyślne: 300000 milisekundy (5 minut).
  • Aby wyłączyć odnawianie automatycznego blokady, ustaw wartość 0.

Przykład:

Jeśli blokada wygaśnie w ciągu 2 minut, a czas przetwarzania wynosi 8 minut...

Ustaw wartość maxAutoLockRenewalDurationInMs na 10 minut, a blokada zostanie automatycznie odnowiona około 4 razy (co odpowiada zablokowaniu sesji przez 4 razy jej czas trwania blokady przy użyciu odnawiania blokady).

maxAutoLockRenewalDurationInMs?: number

Wartość właściwości

number

receiveMode

Reprezentuje tryb odbierania dla odbiornika.

W trybie odbieraniaAndDelete komunikaty są usuwane z usługi Service Bus w miarę ich odbierania.

W trybie peekLock odbiornik ma blokadę komunikatu przez czas określony w kolejce/subskrypcji.

Komunikaty, które nie są rozliczane w ramach czasu trwania blokady, będą ponownie dostarczane tyle razy, ile maksymalna liczba dostaw ustawiona w kolejce/subskrypcji, po której będą wysyłane do oddzielnej kolejki utraconych wiadomości.

Komunikat można rozstrzygnąć, wywołując metody complete(), abandon(), defer() lub deadletter().

Więcej informacji na temat sposobu działania funkcji peekLock i rozliczenia komunikatów można znaleźć tutaj: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Wartość właściwości

"peekLock" | "receiveAndDelete"

skipConvertingDate

Czy pominąć konwertowanie typu daty we właściwościach adnotacji komunikatów lub właściwości aplikacji na liczby podczas odbierania komunikatu. Domyślnie właściwości typu Data są konwertowane na numer epoki SYSTEMU UNIX w celu zapewnienia zgodności.

skipConvertingDate?: boolean

Wartość właściwości

boolean

skipParsingBodyAsJson

Opcja wyłączenia klienta z uruchamiania pliku JSON.parse() w treści komunikatu podczas odbierania komunikatu. Nie dotyczy, jeśli wiadomość została wysłana z wartością typu treści amQP lub sekwencją. Użyj tej opcji, jeśli wolisz pracować bezpośrednio z bajtami obecnymi w treści komunikatu niż klient próbuje go przeanalizować.

skipParsingBodyAsJson?: boolean

Wartość właściwości

boolean

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

Dziedziczone z OperationOptionsBase.abortSignal

tracingOptions

Opcje używane podczas śledzenia są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

Dziedziczone z OperationOptionsBase.tracingOptions