ServiceBusSessionReceiverOptions interface
Descreve as opções passadas para os métodos acceptSession e acceptNextSession ao usar uma Fila/Assinatura com sessões habilitadas.
- Extends
Propriedades
| identifier | Define o nome para identificar o recetor da sessão. Isso pode ser usado para correlacionar logs e exceções. Se não for especificado ou vazio, será usado um único aleatório. |
| max |
A duração máxima, em milissegundos, que o bloqueio na sessão será renovado automaticamente pelo cliente.
Exemplo: Se o bloqueio expirar em 2 minutos e o seu tempo de processamento for de 8 minutos... Defina maxAutoLockRenewalDurationInMs para 10 minutos, e o bloqueio será renovado automaticamente cerca de 4 vezes (equivalente a ter a sessão bloqueada por 4 vezes sua duração de bloqueio aproveitando as renovações de bloqueio). |
| receive |
Representa o modo de receção para o recetor. No modo receiveAndDelete, as mensagens são excluídas do Service Bus à medida que são recebidas. No modo peekLock, o recetor tem um bloqueio na mensagem para a duração especificada na fila / assinatura. As mensagens que não forem resolvidas dentro da duração do bloqueio serão reentregues tantas vezes quanto a contagem máxima de entrega definida na fila/assinatura, após o que serão enviadas para uma fila de letra morta separada. Você pode resolver uma mensagem chamando os 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 deve ignorar a conversão do tipo de data em propriedades de anotações de mensagem ou propriedades de aplicativo em números ao receber a mensagem. Por padrão, as propriedades do tipo Data são convertidas em número de época UNIX para compatibilidade. |
| skip |
Opção para desativar 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 abortar solicitações. |
| tracing |
Opções usadas quando o rastreamento está habilitado. |
Detalhes de Propriedade
identifier
Define o nome para identificar o recetor da sessão. Isso pode ser usado para correlacionar logs e exceções. Se não for especificado ou vazio, será usado um único aleatório.
identifier?: stringValor de Propriedade
string
maxAutoLockRenewalDurationInMs
A duração máxima, em milissegundos, que o bloqueio na sessão será renovado automaticamente pelo cliente.
-
padrão:
300000milissegundos (5 minutos). -
Para desativar ode renovação de bloqueio automático , defina esta opção como
0.
Exemplo:
Se o bloqueio expirar em 2 minutos e o seu tempo de processamento for de 8 minutos...
Defina maxAutoLockRenewalDurationInMs para 10 minutos, e o bloqueio será renovado automaticamente cerca de 4 vezes (equivalente a ter a sessão bloqueada por 4 vezes sua duração de bloqueio aproveitando as renovações de bloqueio).
maxAutoLockRenewalDurationInMs?: numberValor de Propriedade
number
receiveMode
Representa o modo de receção para o recetor.
No modo receiveAndDelete, as mensagens são excluídas do Service Bus à medida que são recebidas.
No modo peekLock, o recetor tem um bloqueio na mensagem para a duração especificada na fila / assinatura.
As mensagens que não forem resolvidas dentro da duração do bloqueio serão reentregues tantas vezes quanto a contagem máxima de entrega definida na fila/assinatura, após o que serão enviadas para uma fila de letra morta separada.
Você pode resolver uma mensagem chamando os 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 de Propriedade
"peekLock" | "receiveAndDelete"
skipConvertingDate
Se deve ignorar a conversão do tipo de data em propriedades de anotações de mensagem ou propriedades de aplicativo em números ao receber a mensagem. Por padrão, as propriedades do tipo Data são convertidas em número de época UNIX para compatibilidade.
skipConvertingDate?: booleanValor de Propriedade
boolean
skipParsingBodyAsJson
Opção para desativar 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 de Propriedade
boolean
Detalhes da Propriedade Herdada
abortSignal
O sinal que pode ser usado para abortar solicitações.
abortSignal?: AbortSignalLikeValor de Propriedade
herdado de OperationOptionsBase.abortSignal
tracingOptions
Opções usadas quando o rastreamento está habilitado.
tracingOptions?: OperationTracingOptionsValor de Propriedade
herdado de OperationOptionsBase.tracingOptions