ServiceBusReceiverOptions interface
Параметры, используемые при создании приемника.
Свойства
identifier | Задает имя для идентификации получателя. Это можно использовать для сопоставления журналов и исключений. Если он не указан или пуст, будет использоваться случайный уникальный. |
max |
Максимальная длительность (в миллисекундах) автоматического продления блокировки сообщения клиентом. Это автоматическое продление останавливается после того, как сообщение будет урегулировано.
Пример. Если срок действия блокировки сообщений истекает через 2 минуты, а время обработки сообщения составляет 8 минут... Установите для maxAutoLockRenewalDurationInMs значение 10 минут, и блокировка сообщения будет автоматически продлеваться в течение 4 раз (эквивалентно блокировке сообщения в 4 раза за счет продления блокировки). |
receive |
Представляет режим получения для получателя. В режиме receiveAndDelete сообщения удаляются из служебной шины по мере их получения. В режиме peekLock получатель блокирует сообщение на срок, указанный в очереди или подписке. Сообщения, которые не были урегулированы в течение срока блокировки, будут повторно доставлены столько раз, сколько максимальное количество доставок, установленное в очереди или подписке, после чего они будут отправлены в отдельную очередь недоставленных сообщений. Вы можете урегулировать сообщение, вызвав методы complete(), abandon(), defer() или deadletter() в сообщении. Дополнительные сведения о том, как работает просмотр и урегулирование сообщений, см. здесь: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
skip |
Следует ли пропускать преобразование типа даты в свойствах заметок к сообщению или свойств приложения в числа при получении сообщения. По умолчанию свойства типа Date преобразуются в номер эпохи UNIX для обеспечения совместимости. |
skip |
Параметр для отключения запуска json.parse() в тексте сообщения при получении сообщения. Неприменимо, если сообщение было отправлено со значением или последовательностью типа текста AMQP. Используйте этот параметр, если вы предпочитаете работать непосредственно с байтами, имеющимися в тексте сообщения, чем при попытке клиента проанализировать его. |
sub |
Представляет вложенную очередь, применимую для любой очереди или подписки. Допустимые значения: deadLetter и transferDeadLetter. Дополнительные сведения об очередях недоставленных сообщений см. в разделе https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues |
Сведения о свойстве
identifier
Задает имя для идентификации получателя. Это можно использовать для сопоставления журналов и исключений. Если он не указан или пуст, будет использоваться случайный уникальный.
identifier?: string
Значение свойства
string
maxAutoLockRenewalDurationInMs
Максимальная длительность (в миллисекундах) автоматического продления блокировки сообщения клиентом. Это автоматическое продление останавливается после того, как сообщение будет урегулировано.
-
Значение по умолчанию:
300 * 1000
миллисекунда (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
subQueueType
Представляет вложенную очередь, применимую для любой очереди или подписки. Допустимые значения: deadLetter и transferDeadLetter. Дополнительные сведения об очередях недоставленных сообщений см. в разделе https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues
subQueueType?: "deadLetter" | "transferDeadLetter"
Значение свойства
"deadLetter" | "transferDeadLetter"