ServiceBusSessionReceiverOptions interface

Paquete:

@azure/service-bus

Describe las opciones que se pasan a los acceptSession métodos y acceptNextSession cuando se usa una cola o suscripción que tiene habilitadas las sesiones.

Extends

OperationOptionsBase

Propiedades

identifier	Establece el nombre para identificar el receptor de sesión. Se puede usar para correlacionar registros y excepciones. Si no se especifica o está vacío, se usará una única aleatoria.
maxAutoLockRenewalDurationInMs	La duración máxima, en milisegundos, que el cliente renovará automáticamente el bloqueo en la sesión. Valor predeterminado: 300000 milisegundos (5 minutos). Para deshabilitar la renovación de bloqueo automático, establezca esta opción en 0. Ejemplo: Si el bloqueo expira en 2 minutos y el tiempo de procesamiento es de 8 minutos... Establezca maxAutoLockRenewalDurationInMs en 10 minutos y el bloqueo se renovará automáticamente aproximadamente 4 veces (equivalente a que la sesión se bloquee durante 4 veces su duración de bloqueo aprovechando las renovaciones de bloqueo).
receiveMode	Representa el modo de recepción del receptor. En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben. En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola o suscripción. Los mensajes que no se liquidan dentro de la duración del bloqueo se volverán a entregar tantas veces como el número máximo de entregas establecido en la cola o suscripción, después de lo cual se envían a una cola de mensajes fallidos independiente. Puede liquidar un mensaje llamando a métodos complete(), abandon(), defer() o deadletter() en el mensaje. Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	Si se omite la conversión del tipo de fecha en propiedades de anotaciones de mensaje o propiedades de aplicación en números al recibir el mensaje. De forma predeterminada, las propiedades del tipo Date se convierten en el número de época de UNIX por motivos de compatibilidad.
skipParsingBodyAsJson	Opción para deshabilitar que el cliente ejecute JSON.parse() en el cuerpo del mensaje al recibir el mensaje. No es aplicable si el mensaje se envió con el valor o secuencia del tipo de cuerpo AMQP. Use esta opción cuando prefiera trabajar directamente con los bytes presentes en el cuerpo del mensaje que si el cliente intenta analizarla.

Propiedades heredadas

abortSignal	Señal que se puede usar para anular las solicitudes.
tracingOptions	Opciones usadas al habilitar el seguimiento.

Detalles de las propiedades

identifier

Establece el nombre para identificar el receptor de sesión. Se puede usar para correlacionar registros y excepciones. Si no se especifica o está vacío, se usará una única aleatoria.

identifier?: string

Valor de propiedad

string

maxAutoLockRenewalDurationInMs

La duración máxima, en milisegundos, que el cliente renovará automáticamente el bloqueo en la sesión.

• Valor predeterminado: 300000 milisegundos (5 minutos).
• Para deshabilitar la renovación de bloqueo automático, establezca esta opción en 0.

Ejemplo:

Si el bloqueo expira en 2 minutos y el tiempo de procesamiento es de 8 minutos...

Establezca maxAutoLockRenewalDurationInMs en 10 minutos y el bloqueo se renovará automáticamente aproximadamente 4 veces (equivalente a que la sesión se bloquee durante 4 veces su duración de bloqueo aprovechando las renovaciones de bloqueo).

maxAutoLockRenewalDurationInMs?: number

Valor de propiedad

number

receiveMode

Representa el modo de recepción del receptor.

En el modo receiveAndDelete, los mensajes se eliminan de Service Bus a medida que se reciben.

En el modo peekLock, el receptor tiene un bloqueo en el mensaje durante la duración especificada en la cola o suscripción.

Los mensajes que no se liquidan dentro de la duración del bloqueo se volverán a entregar tantas veces como el número máximo de entregas establecido en la cola o suscripción, después de lo cual se envían a una cola de mensajes fallidos independiente.

Puede liquidar un mensaje llamando a métodos complete(), abandon(), defer() o deadletter() en el mensaje.

Más información sobre cómo funciona peekLock y la liquidación de mensajes aquí: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Valor de propiedad

"peekLock" | "receiveAndDelete"

skipConvertingDate

Si se omite la conversión del tipo de fecha en propiedades de anotaciones de mensaje o propiedades de aplicación en números al recibir el mensaje. De forma predeterminada, las propiedades del tipo Date se convierten en el número de época de UNIX por motivos de compatibilidad.

skipConvertingDate?: boolean

Valor de propiedad

boolean

skipParsingBodyAsJson

Opción para deshabilitar que el cliente ejecute JSON.parse() en el cuerpo del mensaje al recibir el mensaje. No es aplicable si el mensaje se envió con el valor o secuencia del tipo de cuerpo AMQP. Use esta opción cuando prefiera trabajar directamente con los bytes presentes en el cuerpo del mensaje que si el cliente intenta analizarla.

skipParsingBodyAsJson?: boolean

Valor de propiedad

boolean

Detalles de las propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

Heredado de OperationOptionsBase.abortSignal

tracingOptions

Opciones usadas al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

Heredado de OperationOptionsBase.tracingOptions