Udostępnij za pośrednictwem

SubscribeOptions interface

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

Opcje używane podczas subskrybowania kolejki lub subskrypcji usługi Service Bus.

Extends
OperationOptionsBase

Właściwości

autoCompleteMessages

Wskazuje, czy komunikat powinien być rozliczany automatycznie na podstawie wyniku podanego processMessage przez użytkownika wywołania zwrotnego.

  • Jeśli z wywołania zwrotnego processMessage zostanie zgłoszony błąd, komunikat zostanie porzucony przy użyciu polecenia receiver.abandonMessage(). Spowoduje to ponowne udostępnienie komunikatu z kolejki/subskrypcji, a liczba dostaw zostanie zwiększona.
  • Jeśli nie zostanie zgłoszony błąd z processMessage komunikatu, zostanie ukończony przy użyciu polecenia receiver.completeMessage(). Spowoduje to usunięcie komunikatu z kolejki/subskrypcji.

Ta opcja jest ignorowana, jeśli komunikaty są odbierane w receiveAndDelete trybie odbierania lub jeśli komunikat został już rozliczony w wywołaniu zwrotnym komunikatu podanego przez użytkownika.

  • Wartość domyślna: true.
maxConcurrentCalls

Maksymalna liczba współbieżnych wywołań, które biblioteka może wykonać w programie obsługi komunikatów użytkownika. Po osiągnięciu tego limitu więcej komunikatów nie zostanie odebranych, dopóki nie zostanie ukończona jedna z wywołań programu obsługi komunikatów użytkownika.

  • Wartość domyślna: 1.

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

autoCompleteMessages

Wskazuje, czy komunikat powinien być rozliczany automatycznie na podstawie wyniku podanego processMessage przez użytkownika wywołania zwrotnego.

  • Jeśli z wywołania zwrotnego processMessage zostanie zgłoszony błąd, komunikat zostanie porzucony przy użyciu polecenia receiver.abandonMessage(). Spowoduje to ponowne udostępnienie komunikatu z kolejki/subskrypcji, a liczba dostaw zostanie zwiększona.
  • Jeśli nie zostanie zgłoszony błąd z processMessage komunikatu, zostanie ukończony przy użyciu polecenia receiver.completeMessage(). Spowoduje to usunięcie komunikatu z kolejki/subskrypcji.

Ta opcja jest ignorowana, jeśli komunikaty są odbierane w receiveAndDelete trybie odbierania lub jeśli komunikat został już rozliczony w wywołaniu zwrotnym komunikatu podanego przez użytkownika.

  • Wartość domyślna: true.
autoCompleteMessages?: boolean

Wartość właściwości

boolean

maxConcurrentCalls

Maksymalna liczba współbieżnych wywołań, które biblioteka może wykonać w programie obsługi komunikatów użytkownika. Po osiągnięciu tego limitu więcej komunikatów nie zostanie odebranych, dopóki nie zostanie ukończona jedna z wywołań programu obsługi komunikatów użytkownika.

  • Wartość domyślna: 1.
maxConcurrentCalls?: number

Wartość właściwości

number

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