ServiceBusSessionReceiverOptions interface
Descreve as opções passadas para os acceptSession
métodos e acceptNextSession
ao usar uma Fila/Assinatura que tem sessões habilitadas.
- Extends
Propriedades
identifier | Define o nome para identificar o receptor da sessão. Isso pode ser usado para correlacionar logs e exceções. Se não for especificado ou vazio, um aleatório exclusivo será usado. |
max |
A duração máxima, em milissegundos, de que o bloqueio na sessão será renovado automaticamente pelo cliente.
Exemplo: Se o bloqueio expirar em 2 minutos e o tempo de processamento for de 8 minutos... Defina maxAutoLockRenewalDurationInMs como 10 minutos e o bloqueio será renovado automaticamente cerca de 4 vezes (equivalente a ter a sessão bloqueada por 4 vezes a duração do bloqueio aproveitando as renovações de bloqueio). |
receive |
Representa o modo de recebimento para o receptor. No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas. No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila/assinatura. As mensagens que não são liquidadas dentro da duração do bloqueio serão entregues novamente quantas vezes a contagem máxima de entregas definir na fila/assinatura, após a qual serão enviadas para uma fila de mensagens mortas separada. Você pode resolver uma mensagem chamando métodos complete(), abandon(), defer() ou deadletter() na mensagem. Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock |
skip |
Se é necessário ignorar a conversão do tipo Date em propriedades de anotações de mensagem ou propriedades do aplicativo em números ao receber a mensagem. Por padrão, as propriedades do tipo Date são convertidas em número de época UNIX para compatibilidade. |
skip |
Opção para desabilitar o cliente de executar JSON.parse() no corpo da mensagem ao receber a mensagem. Não aplicável se a mensagem foi enviada com o valor ou a sequência do tipo de corpo AMQP. Use essa opção quando preferir trabalhar diretamente com os bytes presentes no corpo da mensagem do que fazer com que o cliente tente analisá-la. |
Propriedades herdadas
abort |
O sinal que pode ser usado para anular solicitações. |
tracing |
Opções usadas quando o rastreamento está habilitado. |
Detalhes da propriedade
identifier
Define o nome para identificar o receptor da sessão. Isso pode ser usado para correlacionar logs e exceções. Se não for especificado ou vazio, um aleatório exclusivo será usado.
identifier?: string
Valor da propriedade
string
maxAutoLockRenewalDurationInMs
A duração máxima, em milissegundos, de que o bloqueio na sessão será renovado automaticamente pelo cliente.
-
Padrão:
300000
milissegundos (5 minutos). -
Para desabilitar a renovação do bloqueio automático, defina isso
0
como .
Exemplo:
Se o bloqueio expirar em 2 minutos e o tempo de processamento for de 8 minutos...
Defina maxAutoLockRenewalDurationInMs como 10 minutos e o bloqueio será renovado automaticamente cerca de 4 vezes (equivalente a ter a sessão bloqueada por 4 vezes a duração do bloqueio aproveitando as renovações de bloqueio).
maxAutoLockRenewalDurationInMs?: number
Valor da propriedade
number
receiveMode
Representa o modo de recebimento para o receptor.
No modo receiveAndDelete, as mensagens são excluídas do Barramento de Serviço conforme são recebidas.
No modo peekLock, o receptor tem um bloqueio na mensagem pela duração especificada na fila/assinatura.
As mensagens que não são liquidadas dentro da duração do bloqueio serão entregues novamente quantas vezes a contagem máxima de entregas definir na fila/assinatura, após a qual serão enviadas para uma fila de mensagens mortas separada.
Você pode resolver uma mensagem chamando métodos complete(), abandon(), defer() ou deadletter() na mensagem.
Mais informações sobre como o peekLock e a liquidação de mensagens funcionam aqui: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
receiveMode?: "peekLock" | "receiveAndDelete"
Valor da propriedade
"peekLock" | "receiveAndDelete"
skipConvertingDate
Se é necessário ignorar a conversão do tipo Date em propriedades de anotações de mensagem ou propriedades do aplicativo em números ao receber a mensagem. Por padrão, as propriedades do tipo Date são convertidas em número de época UNIX para compatibilidade.
skipConvertingDate?: boolean
Valor da propriedade
boolean
skipParsingBodyAsJson
Opção para desabilitar o cliente de executar JSON.parse() no corpo da mensagem ao receber a mensagem. Não aplicável se a mensagem foi enviada com o valor ou a sequência do tipo de corpo AMQP. Use essa opção quando preferir trabalhar diretamente com os bytes presentes no corpo da mensagem do que fazer com que o cliente tente analisá-la.
skipParsingBodyAsJson?: boolean
Valor da propriedade
boolean
Detalhes das propriedades herdadas
abortSignal
O sinal que pode ser usado para anular solicitações.
abortSignal?: AbortSignalLike
Valor da propriedade
Herdado de OperationOptionsBase.abortSignal
tracingOptions
Opções usadas quando o rastreamento está habilitado.
tracingOptions?: OperationTracingOptions
Valor da propriedade
Herdado de OperationOptionsBase.tracingOptions