Поделиться через

ServiceBusSessionReceiverOptions interface

  • Ссылка
Пакет:
@azure/service-bus

Описывает параметры, передаваемые acceptSession методам и acceptNextSession при использовании очереди или подписки с включенными сеансами.

Extends
OperationOptionsBase

Свойства

identifier

Задает имя для идентификации приемника сеанса. Это можно использовать для сопоставления журналов и исключений. Если он не указан или пуст, будет использоваться случайный уникальный.
maxAutoLockRenewalDurationInMs

Максимальная продолжительность (в миллисекундах) автоматического продления блокировки сеанса клиентом.

  • Значение по умолчанию: 300000 миллисекунда (5 минут).
  • Чтобы отключить автоматическое продление блокировки, задайте для этого параметра значение 0.

Пример.

Если срок действия блокировки истекает через 2 минуты, а время обработки составляет 8 минут...

Установите для maxAutoLockRenewalDurationInMs значение 10 минут, и блокировка будет автоматически продлеваться примерно 4 раза (что эквивалентно блокировке сеанса в 4 раза за счет продления блокировки).
receiveMode

Представляет режим получения для получателя.

В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения.

В режиме peekLock получатель блокирует сообщение на срок, указанный в очереди или подписке.

Сообщения, которые не были урегулированы в течение срока блокировки, будут повторно доставлены столько раз, сколько максимальное количество доставок, установленное в очереди или подписке, после чего они будут отправлены в отдельную очередь недоставленных сообщений.

Вы можете урегулировать сообщение, вызвав методы complete(), abandon(), defer() или deadletter() в сообщении.

Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate

Следует ли пропускать преобразование типа даты в свойствах заметок к сообщению или свойств приложения в числа при получении сообщения. По умолчанию свойства типа Date преобразуются в номер эпохи UNIX для обеспечения совместимости.
skipParsingBodyAsJson

Параметр для отключения запуска json.parse() в тексте сообщения при получении сообщения. Неприменимо, если сообщение было отправлено со значением или последовательностью типа текста AMQP. Используйте этот параметр, если вы предпочитаете работать непосредственно с байтами, имеющимися в тексте сообщения, чем при попытке клиента проанализировать его.

Унаследованные свойства

abortSignal

Сигнал, который можно использовать для прерывания запросов.
tracingOptions

Параметры, используемые при включенной трассировке.

Сведения о свойстве

identifier

Задает имя для идентификации приемника сеанса. Это можно использовать для сопоставления журналов и исключений. Если он не указан или пуст, будет использоваться случайный уникальный.

identifier?: string

Значение свойства

string

maxAutoLockRenewalDurationInMs

Максимальная продолжительность (в миллисекундах) автоматического продления блокировки сеанса клиентом.

  • Значение по умолчанию: 300000 миллисекунда (5 минут).
  • Чтобы отключить автоматическое продление блокировки, задайте для этого параметра значение 0.

Пример.

Если срок действия блокировки истекает через 2 минуты, а время обработки составляет 8 минут...

Установите для maxAutoLockRenewalDurationInMs значение 10 минут, и блокировка будет автоматически продлеваться примерно 4 раза (что эквивалентно блокировке сеанса в 4 раза за счет продления блокировки).

maxAutoLockRenewalDurationInMs?: number

Значение свойства

number

receiveMode

Представляет режим получения для получателя.

В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения.

В режиме peekLock получатель блокирует сообщение на срок, указанный в очереди или подписке.

Сообщения, которые не были урегулированы в течение срока блокировки, будут повторно доставлены столько раз, сколько максимальное количество доставок, установленное в очереди или подписке, после чего они будут отправлены в отдельную очередь недоставленных сообщений.

Вы можете урегулировать сообщение, вызвав методы complete(), abandon(), defer() или deadletter() в сообщении.

Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Значение свойства

"peekLock" | "receiveAndDelete"

skipConvertingDate

Следует ли пропускать преобразование типа даты в свойствах заметок к сообщению или свойств приложения в числа при получении сообщения. По умолчанию свойства типа Date преобразуются в номер эпохи UNIX для обеспечения совместимости.

skipConvertingDate?: boolean

Значение свойства

boolean

skipParsingBodyAsJson

Параметр для отключения запуска json.parse() в тексте сообщения при получении сообщения. Неприменимо, если сообщение было отправлено со значением или последовательностью типа текста AMQP. Используйте этот параметр, если вы предпочитаете работать непосредственно с байтами, имеющимися в тексте сообщения, чем при попытке клиента проанализировать его.

skipParsingBodyAsJson?: boolean

Значение свойства

boolean

Сведения об унаследованном свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

Наследуется от OperationOptionsBase.abortSignal

tracingOptions

Параметры, используемые при включенной трассировке.

tracingOptions?: OperationTracingOptions

Значение свойства

OperationTracingOptions

Наследуется от OperationOptionsBase.tracingOptions