ServiceBusSessionReceiver interface

Пакет:

@azure/service-bus

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

Extends

ServiceBusReceiver

Свойства

sessionId	Идентификатор сеанса.
sessionLockedUntilUtc	Время в формате UTC, пока сеанс не заблокирован. Каждый раз при вызове renewSessionLock() этот раз обновляется до текущего времени, а также длительность блокировки, указанная во время создания очереди или подписки. Возвращает неопределенную, пока не будет успешно настроена ссылка приемника AMQP для сеанса.

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

entityPath	Путь к сущности, для которой был создан получатель.
identifier	Имя, используемое для идентификации получателя. Это можно использовать для сопоставления журналов и исключений. Если он не указан или не указан, будет создан случайный уникальный.
isClosed	Возвращает true, если получатель или клиент, создавший его, был закрыт.
receiveMode	Режим получения, используемый для создания приемника.

Методы

getSessionState(OperationOptionsBase)	Возвращает состояние сеанса. Дополнительные сведения о состояниях сеанса см. в состояния сеанса
renewSessionLock(OperationOptionsBase)	Обновляет блокировку сеанса.
setSessionState(any, OperationOptionsBase)	Задает состояние сеанса. Дополнительные сведения о состояниях сеанса см. в состояния сеанса
subscribe(MessageHandlers, SubscribeOptions)	Передает сообщения обработчикам сообщений.

Наследуемые методы

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Блокировка, удерживаемая на сообщении получателем, отпускается, что делает сообщение доступным снова в служебной шине для другой операции получения.
close()	Закрывает приемник. После закрытия получатель не может использоваться для дальнейших операций. Используйте метод createReceiver() в ServiceBusClient для создания нового приемника.
completeMessage(ServiceBusReceivedMessage)	Удаляет сообщение из служебной шины.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Перемещает сообщение в подзаставку недоставки. Чтобы получить недоставленное сообщение, создайте новый Объект QueueClient/SubscriptionClient, используя путь для подзапуска очереди недоставленных сообщений.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Откладывает обработку сообщения. Сохраните sequenceNumber сообщения, чтобы получить его снова в будущем с помощью метода receiveDeferredMessage.
getMessageIterator(GetMessageIteratorOptions)	Возвращает итератор, который можно использовать для получения сообщений из служебной шины.
peekMessages(number, PeekMessagesOptions)	Ознакомьтесь со следующим пакетом активных сообщений (включая отложенные, но не недопустимые сообщения) в очереди или подписке, не изменяя их. Первый вызов peekMessages() получает первое активное сообщение. Каждый последующий вызов получает последующее сообщение. В отличие от полученного сообщения, "просмотр" — это версия сообщения, доступная только для чтения. Его нельзя Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Возвращает обещание, разрешающее массив отложенных сообщений, определяемых заданным sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Возвращает обещание, разрешающее массив сообщений, полученных из служебной шины.
renewMessageLock(ServiceBusReceivedMessage)	Продлевает блокировку сообщения в течение указанного во время создания очереди или подписки. Проверьте свойство lockedUntilUtc в сообщении на время истечения срока действия блокировки. Если сообщение не урегулировано (с помощью complete(), defer() или deadletter(), до истечения срока действия блокировки сообщение возвращается в очередь или подписку для следующей операции получения.

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

sessionId

Идентификатор сеанса.

sessionId: string

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

string

sessionLockedUntilUtc

Время в формате UTC, пока сеанс не заблокирован. Каждый раз при вызове renewSessionLock() этот раз обновляется до текущего времени, а также длительность блокировки, указанная во время создания очереди или подписки.

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

sessionLockedUntilUtc: Date

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

Date

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

entityPath

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

entityPath: string

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

string

унаследовано отServiceBusReceiver.entityPath

identifier

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

identifier: string

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

string

унаследован отServiceBusReceiver.identifier

isClosed

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

isClosed: boolean

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

boolean

унаследован отServiceBusReceiver.isClosed

receiveMode

Режим получения, используемый для создания приемника.

receiveMode: "peekLock" | "receiveAndDelete"

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

"peekLock" | "receiveAndDelete"

наследуется отServiceBusReceiver.receiveMode

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

getSessionState(OperationOptionsBase)

Возвращает состояние сеанса. Дополнительные сведения о состояниях сеанса см. в состояния сеанса

function getSessionState(options?: OperationOptionsBase): Promise<any>

Параметры

options

OperationOptionsBase

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

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

Promise<any>

Состояние этого сеанса

renewSessionLock(OperationOptionsBase)

Обновляет блокировку сеанса.

function renewSessionLock(options?: OperationOptionsBase): Promise<Date>

Параметры

options

OperationOptionsBase

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

Promise<Date>

setSessionState(any, OperationOptionsBase)

Задает состояние сеанса. Дополнительные сведения о состояниях сеанса см. в состояния сеанса

function setSessionState(state: any, options?: OperationOptionsBase): Promise<void>

Параметры

state

any

Состояние, которое необходимо задать.

options

OperationOptionsBase

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

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

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Передает сообщения обработчикам сообщений.

function subscribe(handlers: MessageHandlers, options?: SubscribeOptions): { close() => Promise<void> }

Параметры

handlers

MessageHandlers

Обработчик, который вызывается для сообщений и ошибок.

options

SubscribeOptions

Параметры подписки.

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

{ close() => Promise<void> }

Объект, который может быть закрыт, отправляя все остальные сообщения в handlers и останавливать новые сообщения от прибытия.

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

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

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

function abandonMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

Параметры

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

Свойства сообщения, которые нужно изменить при отказе от сообщения.

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

Promise<void>

наследуется отServiceBusReceiver.abandonMessage

close()

Закрывает приемник. После закрытия получатель не может использоваться для дальнейших операций. Используйте метод createReceiver() в ServiceBusClient для создания нового приемника.

function close(): Promise<void>

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

Promise<void>

унаследован отServiceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

Удаляет сообщение из служебной шины.

function completeMessage(message: ServiceBusReceivedMessage): Promise<void>

Параметры

message

ServiceBusReceivedMessage

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

Promise<void>

унаследовано отServiceBusReceiver.completeMessage

deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})

Перемещает сообщение в подзаставку недоставки. Чтобы получить недоставленное сообщение, создайте новый Объект QueueClient/SubscriptionClient, используя путь для подзапуска очереди недоставленных сообщений.

function deadLetterMessage(message: ServiceBusReceivedMessage, options?: DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}): Promise<void>

Параметры

message

ServiceBusReceivedMessage

options

DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}

Параметры DeadLetter, которые можно указать при отклонении сообщения.

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

Promise<void>

наследуется отServiceBusReceiver.deadLetterMessage

deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

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

function deferMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

Параметры

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

Свойства сообщения для изменения при отсрочке сообщения

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

Promise<void>

унаследован отServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

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

function getMessageIterator(options?: GetMessageIteratorOptions): AsyncIterableIterator<ServiceBusReceivedMessage>

Параметры

options

GetMessageIteratorOptions

Набор параметров для управления операцией получения.

• abortSignal: сигнал, используемый для прерывания текущей операции.

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

AsyncIterableIterator<ServiceBusReceivedMessage>

наследуется отServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

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

• Первый вызов peekMessages() получает первое активное сообщение. Каждый последующий вызов получает последующее сообщение.
• В отличие от полученного сообщения, "просмотр" — это версия сообщения, доступная только для чтения. Его нельзя Completed/Abandoned/Deferred/Deadlettered.

function peekMessages(maxMessageCount: number, options?: PeekMessagesOptions): Promise<ServiceBusReceivedMessage[]>

Параметры

maxMessageCount

number

Максимальное количество сообщений для просмотра.

options

PeekMessagesOptions

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

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

Promise<ServiceBusReceivedMessage[]>

наследуется отServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

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

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

Параметры

sequenceNumbers

Long | Long[]

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

options

OperationOptionsBase

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

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

Promise<ServiceBusReceivedMessage[]>

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

наследуется отServiceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

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

function receiveMessages(maxMessageCount: number, options?: ReceiveMessagesOptions): Promise<ServiceBusReceivedMessage[]>

Параметры

maxMessageCount

number

Максимальное количество полученных сообщений.

options

ReceiveMessagesOptions

Набор параметров для управления операцией получения.

• maxWaitTimeInMs: максимальное время ожидания первого сообщения перед возвратом пустого массива, если сообщения недоступны.
• abortSignal: сигнал, используемый для прерывания текущей операции.

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

Promise<ServiceBusReceivedMessage[]>

Обещание, разрешающее массив сообщений.

наследуется отServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

Продлевает блокировку сообщения в течение указанного во время создания очереди или подписки.

• Проверьте свойство lockedUntilUtc в сообщении на время истечения срока действия блокировки.
• Если сообщение не урегулировано (с помощью complete(), defer() или deadletter(), до истечения срока действия блокировки сообщение возвращается в очередь или подписку для следующей операции получения.

function renewMessageLock(message: ServiceBusReceivedMessage): Promise<Date>

Параметры

message

ServiceBusReceivedMessage

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

Promise<Date>

Дата и время истечения срока действия маркера блокировки в формате UTC.

унаследовано отServiceBusReceiver.renewMessageLock