ServiceBusSessionReceiverOptions interface

Pakiet:

@azure/service-bus

Opisuje opcje przekazywane do metod acceptSession i acceptNextSession podczas korzystania z kolejki/subskrypcji, która ma włączone sesje.

Rozszerzenie

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), który blokada w sesji zostanie automatycznie odnowiona przez klienta. domyślny: 300000 milisekund (5 minut). Aby wyłączyćodnawiania automatycznego locka, ustaw tę opcję na wartość 0. przykład : Jeśli blokada wygaśnie za 2 minuty, 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 przez wykorzystanie odnawiania blokady).
receiveMode	Reprezentuje tryb odbierania odbiornika. W trybie receiveAndDelete 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, zostaną ponownie wyświetlone wielokrotnie, gdy maksymalna liczba dostaw ustawiona w kolejce/subskrypcji, po której zostaną wysłane do oddzielnej kolejki utraconych wiadomości. Komunikat można rozstrzygnąć, wywołując metody complete(), abandon(), defer() lub deadletter() w komunikacie. Więcej informacji na temat 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 Date są konwertowane na numer epoki systemu UNIX w celu zachowania 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ą lub sekwencją typu treści protokołu AMQP. 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), który blokada w sesji zostanie automatycznie odnowiona przez klienta.

• domyślny: 300000 milisekund (5 minut).
• Aby wyłączyćodnawiania automatycznego locka, ustaw tę opcję na wartość 0.

przykład :

Jeśli blokada wygaśnie za 2 minuty, 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 przez wykorzystanie odnawiania blokady).

maxAutoLockRenewalDurationInMs?: number

Wartość właściwości

number

receiveMode

Reprezentuje tryb odbierania odbiornika.

W trybie receiveAndDelete 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, zostaną ponownie wyświetlone wielokrotnie, gdy maksymalna liczba dostaw ustawiona w kolejce/subskrypcji, po której zostaną wysłane do oddzielnej kolejki utraconych wiadomości.

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

Więcej informacji na temat 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 Date są konwertowane na numer epoki systemu UNIX w celu zachowania 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ą lub sekwencją typu treści protokołu AMQP. 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