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

ServiceBusSender interface

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

Отправитель можно использовать для отправки сообщений, планирования отправки сообщений на более позднем этапе и отмены таких запланированных сообщений. Используйте функцию createSender ServiceBusClient для создания экземпляра отправителя. Класс Sender является абстракцией по базовой ссылке отправителя AMQP.

Свойства

entityPath

Путь к сущности, для которой был создан отправитель.
identifier

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

Возвращает значение true , если был закрыт отправитель или клиент, создавший его.

Методы

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Отменяет несколько сообщений, которые должны были появиться в очереди или подписке служебной шины.
close()

Закрывает базовую ссылку отправителя AMQP. После закрытия отправителя нельзя использовать для дальнейших операций. createSender Использование функции QueueClient или TopicClient для создания экземпляра нового отправителя
createMessageBatch(CreateMessageBatchOptions)

Создает экземпляр , ServiceBusMessageBatch в который можно добавлять сообщения, пока не будет достигнут максимальный поддерживаемый размер. Пакет можно передать в <xref:send> метод для отправки сообщений в Служебная шина Azure.
scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Планирует, что указанные сообщения будут отображаться в очереди или подписке служебной шины позже.
sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Отправляет указанные сообщения после создания ссылки отправителя AMQP, если она еще не существует.

  • Для отправки сообщений в и (или) включенную session очередь или раздел, задайте sessionId для сообщений свойства и (илиpartitionKey) partition соответственно.
  • Все сообщения, передаваемые в один вызов sendMessages(), должны иметь одинаковые sessionId (при использовании сеансов) и одинаковые partitionKey (при использовании секций).

Примечание.

Если вы хотите отправлять сообщения размером более 1 МБ, отправьте отдельные сообщения вместо пакетного сообщения или массива сообщений, как показано ниже.

await sender.sendMessages(message);

Это связано с тем, что пакетные сообщения еще не могут отправлять большие сообщения. force detached В противном случае произойдет ошибка. Чтение service-bus-premium-messaging#large-messages-support. Дополнительные сведения см. в no 23014.

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

entityPath

Путь к сущности, для которой был создан отправитель.

entityPath: string

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

string

identifier

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

identifier: string

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

string

isClosed

Возвращает значение true , если был закрыт отправитель или клиент, создавший его.

isClosed: boolean

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

boolean

Сведения о методе

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Отменяет несколько сообщений, которые должны были появиться в очереди или подписке служебной шины.

function cancelScheduledMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<void>

Параметры

sequenceNumbers

Long | Long[]

Порядковый номер или массив порядковых номеров сообщений, которые необходимо отменить.

options
OperationOptionsBase

Контейнер параметров для передачи сигнала прерывания или параметров трассировки.

Возвращаемое значение

Promise<void>

close()

Закрывает базовую ссылку отправителя AMQP. После закрытия отправителя нельзя использовать для дальнейших операций. createSender Использование функции QueueClient или TopicClient для создания экземпляра нового отправителя

function close(): Promise<void>

Возвращаемое значение

Promise<void>

createMessageBatch(CreateMessageBatchOptions)

Создает экземпляр , ServiceBusMessageBatch в который можно добавлять сообщения, пока не будет достигнут максимальный поддерживаемый размер. Пакет можно передать в <xref:send> метод для отправки сообщений в Служебная шина Azure.

function createMessageBatch(options?: CreateMessageBatchOptions): Promise<ServiceBusMessageBatch>

Параметры

options
CreateMessageBatchOptions

Настраивает поведение пакета.

  • maxSizeInBytes: верхний предел размера пакета. Функция tryAdd возвращается false после достижения этого предела.

Возвращаемое значение

Promise<ServiceBusMessageBatch>

scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

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

function scheduleMessages(messages: ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], scheduledEnqueueTimeUtc: Date, options?: OperationOptionsBase): Promise<Long[]>

Параметры

messages

ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

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

scheduledEnqueueTimeUtc

Date

Время в формате UTC, в которое сообщения должны быть помещены в очередь.

options
OperationOptionsBase

Контейнер параметров для передачи сигнала прерывания или параметров трассировки.

Возвращаемое значение

Promise<Long[]>

Порядковые номера запланированных сообщений. Вам потребуется порядковый номер, если вы планируете отменить планирование сообщений. Сохраните Long тип "как есть" в приложении без преобразования в число. Так как JavaScript поддерживает только 53-разрядные числа, преобразование Long в число приведет к потере точности.

sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Отправляет указанные сообщения после создания ссылки отправителя AMQP, если она еще не существует.

  • Для отправки сообщений в и (или) включенную session очередь или раздел, задайте sessionId для сообщений свойства и (илиpartitionKey) partition соответственно.
  • Все сообщения, передаваемые в один вызов sendMessages(), должны иметь одинаковые sessionId (при использовании сеансов) и одинаковые partitionKey (при использовании секций).

Примечание.

Если вы хотите отправлять сообщения размером более 1 МБ, отправьте отдельные сообщения вместо пакетного сообщения или массива сообщений, как показано ниже.

await sender.sendMessages(message);

Это связано с тем, что пакетные сообщения еще не могут отправлять большие сообщения. force detached В противном случае произойдет ошибка. Чтение service-bus-premium-messaging#large-messages-support. Дополнительные сведения см. в no 23014.

function sendMessages(messages: ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], options?: OperationOptionsBase): Promise<void>

Параметры

messages

ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Одно сообщение или массив сообщений или пакет сообщений, созданных с помощью метода createBatch() для отправки.

options
OperationOptionsBase

Контейнер параметров для передачи сигнала прерывания или параметров трассировки.

Возвращаемое значение

Promise<void>