ServiceBusSessionReceiverOptions interface
Descreve as opções passadas para os métodos acceptSession e acceptNextSession ao usar uma fila/assinatura que tenha 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 do 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 forem resolvidas dentro da duração do bloqueio serão retornadas quantas vezes a contagem máxima de entrega definida na fila/assinatura, após a qual elas sã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 o acordo 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 mensagens 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 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?: stringValor 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:
300000milissegundos (5 minutos). -
Para desabilitar ode renovação de bloqueio automático, defina-o como
0.
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?: numberValor da propriedade
number
receiveMode
Representa o modo de recebimento do 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 forem resolvidas dentro da duração do bloqueio serão retornadas quantas vezes a contagem máxima de entrega definida na fila/assinatura, após a qual elas sã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 o acordo 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 mensagens 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?: booleanValor 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 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?: booleanValor da propriedade
boolean
Detalhes das propriedades herdadas
abortSignal
O sinal que pode ser usado para anular solicitações.
abortSignal?: AbortSignalLikeValor da propriedade
herdado de OperationOptionsBase.abortSignal
tracingOptions
Opções usadas quando o rastreamento está habilitado.
tracingOptions?: OperationTracingOptionsValor da propriedade
herdado de OperationOptionsBase.tracingOptions