ServiceBusSessionReceiver interface

Pacote:

@azure/service-bus

Um recetor que lida com sessões, incluindo a renovação do bloqueio de sessão.

Extends

ServiceBusReceiver

Propriedades

sessionId	O ID da sessão.
sessionLockedUntilUtc	A hora em UTC até a qual a sessão está bloqueada. Sempre que renewSessionLock() é chamado, esse tempo é atualizado 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 do recetor AMQP tenha sido configurado com êxito para a sessão.

Propriedades Herdadas

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

Métodos

getSessionState(OperationOptionsBase)	Obtém o estado da sessão. Para obter mais informações sobre os estados da sessão, consulte Estado da Sessão
renewSessionLock(OperationOptionsBase)	Renova o bloqueio da sessão.
setSessionState(any, OperationOptionsBase)	Define o estado na sessão. Para obter mais informações sobre os estados da 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 recetor é liberado, tornando a mensagem disponível novamente no Service Bus para outra operação de recebimento.
close()	Fecha o recetor. Uma vez fechado, o recetor não pode ser usado para quaisquer outras operações. Use o método createReceiver() no ServiceBusClient para criar um novo Receiver.
completeMessage(ServiceBusReceivedMessage)	Remove a mensagem do Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Move a mensagem para a subfila deadletter. Para receber uma mensagem com deadlet, crie um novo QueueClient/SubscriptionClient usando o caminho para a subfila deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Adia o processamento da mensagem. Salve a sequenceNumber da mensagem, a fim de recebê-la novamente no futuro usando o método receiveDeferredMessage.
getMessageIterator(GetMessageIteratorOptions)	Retorna um iterador que pode ser usado para receber mensagens do Service Bus.
peekMessages(number, PeekMessagesOptions)	Espreite o próximo lote de mensagens ativas (incluindo mensagens adiadas, mas não com letras mortas) na fila ou na subscrição sem as modificar. 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 resolve para uma matriz de mensagens adiadas identificadas por determinado sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Retorna uma promessa que resolve para uma matriz de mensagens recebidas do Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Renova o bloqueio na mensagem pela duração especificada durante a criação da Fila/Assinatura. Verifique a propriedade lockedUntilUtc na mensagem para o momento em que o bloqueio expira. Se uma mensagem não for resolvida (usando complete(), defer() ou deadletter(), antes que seu bloqueio expire, a mensagem será enviada de volta para a Fila/Assinatura para a próxima operação de recebimento.

Detalhes de Propriedade

sessionId

O ID da sessão.

sessionId: string

Valor de Propriedade

string

sessionLockedUntilUtc

A hora em UTC até a qual a sessão está bloqueada. Sempre que renewSessionLock() é chamado, esse tempo é atualizado 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 do recetor AMQP tenha sido configurado com êxito para a sessão.

sessionLockedUntilUtc: Date

Valor de Propriedade

Date

Detalhes da Propriedade Herdada

entityPath

Caminho da entidade para a qual o recetor foi criado.

entityPath: string

Valor de Propriedade

string

herdado de ServiceBusReceiver.entityPath

identifier

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

identifier: string

Valor de Propriedade

string

herdado deServiceBusReceiver.identifier

isClosed

Retorna true se o recetor ou o cliente que o criou tiver sido fechado.

isClosed: boolean

Valor de Propriedade

boolean

herdado deServiceBusReceiver.isClosed

receiveMode

O modo de receção usado para criar o recetor.

receiveMode: "peekLock" | "receiveAndDelete"

Valor de Propriedade

"peekLock" | "receiveAndDelete"

herdado de ServiceBusReceiver.receiveMode

Detalhes de Método

getSessionState(OperationOptionsBase)

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

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

Parâmetros

options

OperationOptionsBase

Opções de saco para passar um sinal de abortamento ou opções de rastreamento.

Devoluções

Promise<any>

O estado da sessão

renewSessionLock(OperationOptionsBase)

Renova o bloqueio da sessão.

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

Parâmetros

options

OperationOptionsBase

Devoluções

Promise<Date>

setSessionState(any, OperationOptionsBase)

Define o estado na sessão. Para obter mais informações sobre os estados da 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

Opções de saco para passar um sinal de abortamento ou opções de rastreamento.

Devoluções

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 subscrever.

Devoluções

{ close() => Promise<void> }

Um objeto que pode ser fechado, enviando quaisquer 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 recetor é liberado, tornando a mensagem disponível novamente no Service Bus 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 abandoná-la.

Devoluções

Promise<void>

herdado deServiceBusReceiver.abandonMessage

close()

Fecha o recetor. Uma vez fechado, o recetor não pode ser usado para quaisquer outras operações. Use o método createReceiver() no ServiceBusClient para criar um novo Receiver.

function close(): Promise<void>

Devoluções

Promise<void>

herdado deServiceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

Remove a mensagem do Service Bus.

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

Parâmetros

message

ServiceBusReceivedMessage

Devoluções

Promise<void>

herdado de ServiceBusReceiver.completeMessage

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

Move a mensagem para a subfila deadletter. Para receber uma mensagem com deadlet, crie um novo QueueClient/SubscriptionClient usando o caminho para a subfila deadletter.

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 DeadLetter que podem ser fornecidas ao rejeitar a mensagem.

Devoluções

Promise<void>

herdado deServiceBusReceiver.deadLetterMessage

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

Adia o processamento da mensagem. Salve a sequenceNumber da mensagem, a fim de recebê-la novamente no futuro usando o método receiveDeferredMessage.

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 ser modificada ao adiar a mensagem

Devoluções

Promise<void>

herdado de ServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

Retorna um iterador que pode ser usado para receber mensagens do Service Bus.

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

Parâmetros

options

GetMessageIteratorOptions

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

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

Devoluções

AsyncIterableIterator<ServiceBusReceivedMessage>

herdado de ServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Espreite o próximo lote de mensagens ativas (incluindo mensagens adiadas, mas não com letras mortas) na fila ou na subscrição sem as modificar.

• 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 espreitar.

options

PeekMessagesOptions

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

Devoluções

Promise<ServiceBusReceivedMessage[]>

herdado doServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Retorna uma promessa que resolve 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

Opções de saco para passar um sinal de abortamento ou opções de rastreamento.

Devoluções

Promise<ServiceBusReceivedMessage[]>

Uma lista de mensagens identificadas pela sequência fornecidaNúmeros ou uma lista vazia se nenhuma mensagem for encontrada.

herdado deServiceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

Retorna uma promessa que resolve para uma matriz de mensagens recebidas do Service Bus.

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

Parâmetros

maxMessageCount

number

O número máximo de mensagens a receber.

options

ReceiveMessagesOptions

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

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

Devoluções

Promise<ServiceBusReceivedMessage[]>

Uma promessa que se resolve com uma série de mensagens.

herdado deServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

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

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

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

Parâmetros

message

ServiceBusReceivedMessage

Devoluções

Promise<Date>

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

herdado de ServiceBusReceiver.renewMessageLock