ServiceBusSessionReceiver interface

Pacote:

@azure/service-bus

Um receptor que manipula sessões, incluindo a renovação do bloqueio de sessão.

Extends

ServiceBusReceiver

Propriedades

sessionId	A ID da sessão.
sessionLockedUntilUtc	A hora em UTC até a qual a sessão está bloqueada. Sempre que renewSessionLock() é chamado, essa hora é atualizada para a hora atual mais a duração do bloqueio, conforme especificado durante a criação da Fila/Assinatura. Retornará indefinido até que um link de receptor AMQP tenha sido configurado com êxito para a sessão.

Propriedades herdadas

entityPath	Caminho da entidade para a qual o receptor foi criado.
identifier	Um nome usado para identificar o receptor. Isso pode ser usado para correlacionar logs e exceções. Se não for especificado ou vazio, um aleatório exclusivo será gerado.
isClosed	Retornará true se o receptor ou o cliente que o criou tiver sido fechado.
receiveMode	O modo de recebimento usado para criar o receptor.

Métodos

getSessionState(OperationOptionsBase)	Obtém o estado da Sessão. Para obter mais informações sobre estados de sessão, consulte Estado da sessão
renewSessionLock(OperationOptionsBase)	Renova o bloqueio na sessão.
setSessionState(any, OperationOptionsBase)	Define o estado na Sessão. Para obter mais informações sobre estados de sessão, consulte Estado da sessão
subscribe(MessageHandlers, SubscribeOptions)	Transmite mensagens para manipuladores de mensagens.

Métodos herdados

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	O bloqueio mantido na mensagem pelo receptor é solto, disponibilizando a mensagem novamente no Barramento de Serviço para outra operação de recebimento.
close()	Fecha o receptor. Depois de fechado, o receptor não pode ser usado para operações adicionais. Use o createReceiver() método no ServiceBusClient para criar um novo Receptor.
completeMessage(ServiceBusReceivedMessage)	Remove a mensagem do Barramento de Serviço.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Move a mensagem para a sub-fila de mensagens mortas. Para receber uma mensagem morta, crie um novo QueueClient/SubscriptionClient usando o caminho para a sub-fila de mensagens mortas.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Adia o processamento da mensagem. Salve o sequenceNumber da mensagem para receber a mensagem novamente no futuro usando o receiveDeferredMessage método .
getMessageIterator(GetMessageIteratorOptions)	Retorna um iterador que pode ser usado para receber mensagens do Barramento de Serviço.
peekMessages(number, PeekMessagesOptions)	Espie o próximo lote de mensagens ativas (incluindo mensagens adiadas, mas não mortas) na fila ou assinatura sem modificá-las. A primeira chamada para peekMessages() busca a primeira mensagem ativa. Cada chamada subsequente busca a mensagem subsequente. Ao contrário de uma mensagem "recebida", a mensagem "espiada" é uma versão somente leitura da mensagem. Não pode ser Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Retorna uma promessa que é resolvida para uma matriz de mensagens adiadas identificadas por determinado sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Retorna uma promessa que é resolvida para uma matriz de mensagens recebidas do Barramento de Serviço.
renewMessageLock(ServiceBusReceivedMessage)	Renova o bloqueio na mensagem pela duração, conforme especificado durante a criação da Fila/Assinatura. Verifique a lockedUntilUtc propriedade na mensagem para a hora em que o bloqueio expira. Se uma mensagem não for resolvida (usando complete(), defer() ou deadletter(), antes de seu bloqueio expirar, a mensagem retornará à Fila/Assinatura para a próxima operação de recebimento.

Detalhes da propriedade

sessionId

A ID da sessão.

sessionId: string

Valor da propriedade

string

sessionLockedUntilUtc

A hora em UTC até a qual a sessão está bloqueada. Sempre que renewSessionLock() é chamado, essa hora é atualizada para a hora atual mais a duração do bloqueio, conforme especificado durante a criação da Fila/Assinatura.

Retornará indefinido até que um link de receptor AMQP tenha sido configurado com êxito para a sessão.

sessionLockedUntilUtc: Date

Valor da propriedade

Date

Detalhes das propriedades herdadas

entityPath

Caminho da entidade para a qual o receptor foi criado.

entityPath: string

Valor da propriedade

string

Herdado deServiceBusReceiver.entityPath

identifier

Um nome usado para identificar o receptor. Isso pode ser usado para correlacionar logs e exceções. Se não for especificado ou vazio, um aleatório exclusivo será gerado.

identifier: string

Valor da propriedade

string

Herdado deServiceBusReceiver.identifier

isClosed

Retornará true se o receptor ou o cliente que o criou tiver sido fechado.

isClosed: boolean

Valor da propriedade

boolean

Herdado deServiceBusReceiver.isClosed

receiveMode

O modo de recebimento usado para criar o receptor.

receiveMode: "peekLock" | "receiveAndDelete"

Valor da propriedade

"peekLock" | "receiveAndDelete"

Herdado deServiceBusReceiver.receiveMode

Detalhes do método

getSessionState(OperationOptionsBase)

Obtém o estado da Sessão. Para obter mais informações sobre estados de sessão, consulte Estado da sessão

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

Parâmetros

options

OperationOptionsBase

Recipiente de opções para passar um sinal de anulação ou opções de rastreamento.

Retornos

Promise<any>

O estado dessa sessão

renewSessionLock(OperationOptionsBase)

Renova o bloqueio na sessão.

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

Parâmetros

options

OperationOptionsBase

Retornos

Promise<Date>

setSessionState(any, OperationOptionsBase)

Define o estado na Sessão. Para obter mais informações sobre estados de sessão, consulte Estado da sessão

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

Parâmetros

state

any

O estado que precisa ser definido.

options

OperationOptionsBase

Recipiente de opções para passar um sinal de anulação ou opções de rastreamento.

Retornos

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Transmite mensagens para manipuladores de mensagens.

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

Parâmetros

handlers

MessageHandlers

Um manipulador que é chamado para mensagens e erros.

options

SubscribeOptions

Opções para assinatura.

Retornos

{ close() => Promise<void> }

Um objeto que pode ser fechado, enviando todas as mensagens restantes para handlers e impedindo a chegada de novas mensagens.

Detalhes do método herdado

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

O bloqueio mantido na mensagem pelo receptor é solto, disponibilizando a mensagem novamente no Barramento de Serviço para outra operação de recebimento.

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

Parâmetros

message

ServiceBusReceivedMessage

propertiesToModify

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

As propriedades da mensagem a serem modificadas ao abandonar a mensagem.

Retornos

Promise<void>

Herdado deServiceBusReceiver.abandonMessage

close()

Fecha o receptor. Depois de fechado, o receptor não pode ser usado para operações adicionais. Use o createReceiver() método no ServiceBusClient para criar um novo Receptor.

function close(): Promise<void>

Retornos

Promise<void>

Herdado deServiceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

Remove a mensagem do Barramento de Serviço.

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

Parâmetros

message

ServiceBusReceivedMessage

Retornos

Promise<void>

Herdado deServiceBusReceiver.completeMessage

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

Move a mensagem para a sub-fila de mensagens mortas. Para receber uma mensagem morta, crie um novo QueueClient/SubscriptionClient usando o caminho para a sub-fila de mensagens mortas.

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

Parâmetros

message

ServiceBusReceivedMessage

options

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

As opções de DeadLetter que podem ser fornecidas ao rejeitar a mensagem.

Retornos

Promise<void>

Herdado deServiceBusReceiver.deadLetterMessage

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

Adia o processamento da mensagem. Salve o sequenceNumber da mensagem para receber a mensagem novamente no futuro usando o receiveDeferredMessage método .

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

Parâmetros

message

ServiceBusReceivedMessage

propertiesToModify

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

As propriedades da mensagem a serem modificadas ao adiar a mensagem

Retornos

Promise<void>

Herdado deServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

Retorna um iterador que pode ser usado para receber mensagens do Barramento de Serviço.

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

Parâmetros

options

GetMessageIteratorOptions

Um conjunto de opções para controlar a operação de recebimento.

• abortSignal: o sinal a ser usado para anular a operação em andamento.

Retornos

AsyncIterableIterator<ServiceBusReceivedMessage>

Herdado deServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Espie o próximo lote de mensagens ativas (incluindo mensagens adiadas, mas não mortas) na fila ou assinatura sem modificá-las.

• A primeira chamada para peekMessages() busca a primeira mensagem ativa. Cada chamada subsequente busca a mensagem subsequente.
• Ao contrário de uma mensagem "recebida", a mensagem "espiada" é uma versão somente leitura da mensagem. Não pode ser Completed/Abandoned/Deferred/Deadlettered.

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

Parâmetros

maxMessageCount

number

O número máximo de mensagens a serem espiadas.

options

PeekMessagesOptions

Opções que permitem especificar o número máximo de mensagens a serem espiadas, sequenceNumber para começar a espiar ou um abortSignal para anular a operação.

Retornos

Promise<ServiceBusReceivedMessage[]>

Herdado deServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Retorna uma promessa que é resolvida para uma matriz de mensagens adiadas identificadas por determinado sequenceNumbers.

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

Parâmetros

sequenceNumbers

Long | Long[]

O número de sequência ou uma matriz de números de sequência para as mensagens que precisam ser recebidas.

options

OperationOptionsBase

Recipiente de opções para passar um sinal de anulação ou opções de rastreamento.

Retornos

Promise<ServiceBusReceivedMessage[]>

Uma lista de mensagens identificadas pelo sequenceNumbers especificado ou uma lista vazia se nenhuma mensagem for encontrada.

Herdado deServiceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

Retorna uma promessa que é resolvida para uma matriz de mensagens recebidas do Barramento de Serviço.

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

Parâmetros

maxMessageCount

number

O número máximo de mensagens a serem recebidas.

options

ReceiveMessagesOptions

Um conjunto de opções para controlar a operação de recebimento.

• maxWaitTimeInMs: o tempo máximo para aguardar a primeira mensagem antes de retornar uma matriz vazia se nenhuma mensagem estiver disponível.
• abortSignal: o sinal a ser usado para anular a operação em andamento.

Retornos

Promise<ServiceBusReceivedMessage[]>

Uma promessa que é resolvida com uma matriz de mensagens.

Herdado deServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

Renova o bloqueio na mensagem pela duração, conforme especificado durante a criação da Fila/Assinatura.

• Verifique a lockedUntilUtc propriedade na mensagem para a hora em que o bloqueio expira.
• Se uma mensagem não for resolvida (usando complete(), defer() ou deadletter(), antes de seu bloqueio expirar, a mensagem retornará à Fila/Assinatura para a próxima operação de recebimento.

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

Parâmetros

message

ServiceBusReceivedMessage

Retornos

Promise<Date>

Nova data e hora de expiração do token de bloqueio no formato UTC.

Herdado deServiceBusReceiver.renewMessageLock