ServiceBusSessionReceiver interface

Пакет:

@azure/service-bus

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

Extends

ServiceBusReceiver

Свойства

sessionId	Идентификатор сеанса.
sessionLockedUntilUtc	Время в формате UTC, до которого сеанс будет заблокирован. renewSessionLock() При каждом вызове этот раз обновляется до текущего времени и длительности блокировки, указанной при создании очереди или подписки. Возвращает значение undefined, пока не будет успешно настроена связь приемника 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() При каждом вызове этот раз обновляется до текущего времени и длительности блокировки, указанной при создании очереди или подписки.

Возвращает значение undefined, пока не будет успешно настроена связь приемника 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

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

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

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[]>

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

Наследуется от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