ServiceBusReceiverOptions interface

Pakiet:

@azure/service-bus

Opcje do użycia podczas tworzenia odbiornika.

Właściwości

identifier	Ustawia nazwę, aby zidentyfikować odbiornik. 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 komunikatu zostanie automatycznie odnowiona przez klienta. To automatyczne odnawianie zostanie zatrzymane po rozliczeniu komunikatu. Wartość domyślna: 300 * 1000 milisekundy (5 minut). Aby wyłączyć odnawianie automatycznego locka, ustaw tę opcję na 0wartość . Przykład: Jeśli blokada komunikatu wygaśnie za 2 minuty, a czas przetwarzania komunikatu wynosi 8 minut... Ustaw wartość maxAutoLockRenewalDurationInMs na 10 minut, a blokada komunikatu zostanie automatycznie odnowiona przez 4 razy (co odpowiada zablokowaniu komunikatu przez 4 razy jego czas trwania blokady dzięki wykorzystaniu odnowień blokady).
receiveMode	Reprezentuje tryb odbierania dla 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 zostały rozliczone w czasie trwania blokady, zostaną ponownie wysłane do oddzielnej kolejki utraconych komunikatów, ile wynosi maksymalna liczba dostaw ustawiona w kolejce/subskrypcji. 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 pomijać 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 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ą typu treści protokołu 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ć.
subQueueType	Reprezentuje kolejkę podrzędną, która ma zastosowanie do dowolnej kolejki lub subskrypcji. Prawidłowe wartości to "deadLetter" i "transferDeadLetter". Aby dowiedzieć się więcej o kolejkach utraconych komunikatów, zobacz https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Szczegóły właściwości

identifier

Ustawia nazwę, aby zidentyfikować odbiornik. 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 komunikatu zostanie automatycznie odnowiona przez klienta. To automatyczne odnawianie zostanie zatrzymane po rozliczeniu komunikatu.

• Wartość domyślna: 300 * 1000 milisekundy (5 minut).
• Aby wyłączyć odnawianie automatycznego locka, ustaw tę opcję na 0wartość .

Przykład:

Jeśli blokada komunikatu wygaśnie za 2 minuty, a czas przetwarzania komunikatu wynosi 8 minut...

Ustaw wartość maxAutoLockRenewalDurationInMs na 10 minut, a blokada komunikatu zostanie automatycznie odnowiona przez 4 razy (co odpowiada zablokowaniu komunikatu przez 4 razy jego czas trwania blokady dzięki wykorzystaniu odnowień blokady).

maxAutoLockRenewalDurationInMs?: number

Wartość właściwości

number

receiveMode

Reprezentuje tryb odbierania dla 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 zostały rozliczone w czasie trwania blokady, zostaną ponownie wysłane do oddzielnej kolejki utraconych komunikatów, ile wynosi maksymalna liczba dostaw ustawiona w kolejce/subskrypcji.

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 pomijać 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 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ą typu treści protokołu 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

subQueueType

Reprezentuje kolejkę podrzędną, która ma zastosowanie do dowolnej kolejki lub subskrypcji. Prawidłowe wartości to "deadLetter" i "transferDeadLetter". Aby dowiedzieć się więcej o kolejkach utraconych komunikatów, zobacz https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

subQueueType?: "deadLetter" | "transferDeadLetter"

Wartość właściwości

"deadLetter" | "transferDeadLetter"