ServiceBusSessionReceiver interface

Paquete:

@azure/service-bus

Receptor que controla las sesiones, incluida la renovación del bloqueo de sesión.

Extends

ServiceBusReceiver

Propiedades

sessionId	El identificador de sesión.
sessionLockedUntilUtc	La hora en UTC hasta la que se bloquea la sesión. Cada vez renewSessionLock() que se llama a , esta vez se actualiza a la hora actual más la duración del bloqueo según se especifica durante la creación de la cola o suscripción. Devolverá undefined hasta que se haya configurado correctamente un vínculo del receptor AMQP para la sesión.

Propiedades heredadas

entityPath	Ruta de acceso de la entidad para la que se ha creado el receptor.
identifier	Nombre que se usa para identificar el receptor. Se puede usar para correlacionar registros y excepciones. Si no se especifica o está vacío, se generará uno único aleatorio.
isClosed	Devuelve true si el receptor o el cliente que lo creó se ha cerrado.
receiveMode	Modo de recepción utilizado para crear el receptor.

Métodos

getSessionState(OperationOptionsBase)	Obtiene el estado de la sesión. Para más información sobre los estados de sesión, consulte Estado de sesión.
renewSessionLock(OperationOptionsBase)	Renueva el bloqueo en la sesión.
setSessionState(any, OperationOptionsBase)	Establece el estado en la sesión. Para más información sobre los estados de sesión, consulte Estado de sesión.
subscribe(MessageHandlers, SubscribeOptions)	Transmite mensajes a controladores de mensajes.

Métodos heredados

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	El bloqueo mantenido en el mensaje por el receptor deja ir, lo que hace que el mensaje esté disponible de nuevo en Service Bus para otra operación de recepción.
close()	Cierra el receptor. Una vez cerrado, el receptor no se puede usar para otras operaciones. Use el createReceiver() método en ServiceBusClient para crear un nuevo receptor.
completeMessage(ServiceBusReceivedMessage)	Quita el mensaje de Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Mueve el mensaje a la sub cola de mensajes fallidos. Para recibir un mensaje fallido, cree una cola QueueClient o SubscriptionClient con la ruta de acceso de la sub cola de mensajes fallidos.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Aplaza el procesamiento del mensaje. Guarde el sequenceNumber del mensaje para recibirlo de nuevo en el futuro mediante el receiveDeferredMessage método .
getMessageIterator(GetMessageIteratorOptions)	Devuelve un iterador que se puede usar para recibir mensajes de Service Bus.
peekMessages(number, PeekMessagesOptions)	Ver el siguiente lote de mensajes activos (incluidos mensajes diferidos pero no fallidos) en la cola o suscripción sin modificarlos. La primera llamada para peekMessages() capturar el primer mensaje activo. Cada llamada subsiguiente captura el mensaje subsiguiente. A diferencia de un mensaje "recibido", el mensaje "peeked" es una versión de solo lectura del mensaje. No puede ser Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Devuelve una promesa que se resuelve en una matriz de mensajes diferidos identificados por dado sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Devuelve una promesa que se resuelve en una matriz de mensajes recibidos de Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Renueva el bloqueo en el mensaje durante la duración especificada durante la creación de la cola o suscripción. Compruebe la lockedUntilUtc propiedad en el mensaje cuando expire el bloqueo. Si un mensaje no se resuelve (mediante complete(), defer() o deadletter(), antes de que expire su bloqueo, el mensaje vuelve a aparecer en la cola o suscripción para la siguiente operación de recepción.

Detalles de las propiedades

sessionId

El identificador de sesión.

sessionId: string

Valor de propiedad

string

sessionLockedUntilUtc

La hora en UTC hasta la que se bloquea la sesión. Cada vez renewSessionLock() que se llama a , esta vez se actualiza a la hora actual más la duración del bloqueo según se especifica durante la creación de la cola o suscripción.

Devolverá undefined hasta que se haya configurado correctamente un vínculo del receptor AMQP para la sesión.

sessionLockedUntilUtc: Date

Valor de propiedad

Date

Detalles de las propiedades heredadas

entityPath

Ruta de acceso de la entidad para la que se ha creado el receptor.

entityPath: string

Valor de propiedad

string

Heredado deServiceBusReceiver.entityPath

identifier

Nombre que se usa para identificar el receptor. Se puede usar para correlacionar registros y excepciones. Si no se especifica o está vacío, se generará uno único aleatorio.

identifier: string

Valor de propiedad

string

Heredado deServiceBusReceiver.identifier

isClosed

Devuelve true si el receptor o el cliente que lo creó se ha cerrado.

isClosed: boolean

Valor de propiedad

boolean

Heredado deServiceBusReceiver.isClosed

receiveMode

Modo de recepción utilizado para crear el receptor.

receiveMode: "peekLock" | "receiveAndDelete"

Valor de propiedad

"peekLock" | "receiveAndDelete"

Heredado deServiceBusReceiver.receiveMode

Detalles del método

getSessionState(OperationOptionsBase)

Obtiene el estado de la sesión. Para más información sobre los estados de sesión, consulte Estado de sesión.

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

Parámetros

options

OperationOptionsBase

Contenedor de opciones para pasar una señal de anulación o opciones de seguimiento.

Devoluciones

Promise<any>

El estado de esa sesión

renewSessionLock(OperationOptionsBase)

Renueva el bloqueo en la sesión.

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

Parámetros

options

OperationOptionsBase

Devoluciones

Promise<Date>

setSessionState(any, OperationOptionsBase)

Establece el estado en la sesión. Para más información sobre los estados de sesión, consulte Estado de sesión.

function setSessionState(state: any, options?: OperationOptionsBase): Promise<void>

Parámetros

state

any

Estado que se debe establecer.

options

OperationOptionsBase

Contenedor de opciones para pasar una señal de anulación o opciones de seguimiento.

Devoluciones

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Transmite mensajes a controladores de mensajes.

function subscribe(handlers: MessageHandlers, options?: SubscribeOptions): { close() => Promise<void> }

Parámetros

handlers

MessageHandlers

Controlador al que se llama para mensajes y errores.

options

SubscribeOptions

Opciones para suscribirse.

Devoluciones

{ close() => Promise<void> }

Objeto que se puede cerrar, enviando cualquier mensaje restante a handlers y deteniendo nuevos mensajes de llegada.

Detalles de los métodos heredados

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

El bloqueo mantenido en el mensaje por el receptor deja ir, lo que hace que el mensaje esté disponible de nuevo en Service Bus para otra operación de recepción.

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}

Propiedades del mensaje que se van a modificar al abandonar el mensaje.

Devoluciones

Promise<void>

Heredado deServiceBusReceiver.abandonMessage

close()

Cierra el receptor. Una vez cerrado, el receptor no se puede usar para otras operaciones. Use el createReceiver() método en ServiceBusClient para crear un nuevo receptor.

function close(): Promise<void>

Devoluciones

Promise<void>

Heredado deServiceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

Quita el mensaje de Service Bus.

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

Parámetros

message

ServiceBusReceivedMessage

Devoluciones

Promise<void>

Heredado deServiceBusReceiver.completeMessage

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

Mueve el mensaje a la sub cola de mensajes fallidos. Para recibir un mensaje fallido, cree una cola QueueClient o SubscriptionClient con la ruta de acceso de la sub cola de mensajes fallidos.

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}

Las opciones DeadLetter que se pueden proporcionar al rechazar el mensaje.

Devoluciones

Promise<void>

Heredado deServiceBusReceiver.deadLetterMessage

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

Aplaza el procesamiento del mensaje. Guarde el sequenceNumber del mensaje para recibirlo de nuevo en el futuro mediante el receiveDeferredMessage método .

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}

Propiedades del mensaje que se van a modificar al aplazar el mensaje

Devoluciones

Promise<void>

Heredado deServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

Devuelve un iterador que se puede usar para recibir mensajes de Service Bus.

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

Parámetros

options

GetMessageIteratorOptions

Conjunto de opciones para controlar la operación de recepción.

• abortSignal: señal que se va a usar para anular la operación en curso.

Devoluciones

AsyncIterableIterator<ServiceBusReceivedMessage>

Heredado deServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Ver el siguiente lote de mensajes activos (incluidos mensajes diferidos pero no fallidos) en la cola o suscripción sin modificarlos.

• La primera llamada para peekMessages() capturar el primer mensaje activo. Cada llamada subsiguiente captura el mensaje subsiguiente.
• A diferencia de un mensaje "recibido", el mensaje "peeked" es una versión de solo lectura del mensaje. No puede ser Completed/Abandoned/Deferred/Deadlettered.

function peekMessages(maxMessageCount: number, options?: PeekMessagesOptions): Promise<ServiceBusReceivedMessage[]>

Parámetros

maxMessageCount

number

Número máximo de mensajes que se van a ver.

options

PeekMessagesOptions

Opciones que permiten especificar el número máximo de mensajes que se van a ver, sequenceNumber para empezar a inspeccionar desde o abortSignal para anular la operación.

Devoluciones

Promise<ServiceBusReceivedMessage[]>

Heredado deServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Devuelve una promesa que se resuelve en una matriz de mensajes diferidos identificados por dado sequenceNumbers.

function receiveDeferredMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<ServiceBusReceivedMessage[]>

Parámetros

sequenceNumbers

Long | Long[]

Número de secuencia o matriz de números de secuencia para los mensajes que deben recibirse.

options

OperationOptionsBase

Contenedor de opciones para pasar una señal de anulación o opciones de seguimiento.

Devoluciones

Promise<ServiceBusReceivedMessage[]>

Lista de mensajes identificados por sequenceNumbers especificados o una lista vacía si no se encuentra ningún mensaje.

Heredado deServiceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

Devuelve una promesa que se resuelve en una matriz de mensajes recibidos de Service Bus.

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

Parámetros

maxMessageCount

number

Número máximo de mensajes que se van a recibir.

options

ReceiveMessagesOptions

Conjunto de opciones para controlar la operación de recepción.

• maxWaitTimeInMs: tiempo máximo para esperar el primer mensaje antes de devolver una matriz vacía si no hay ningún mensaje disponible.
• abortSignal: señal que se va a usar para anular la operación en curso.

Devoluciones

Promise<ServiceBusReceivedMessage[]>

Promesa que se resuelve con una matriz de mensajes.

Heredado deServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

Renueva el bloqueo en el mensaje durante la duración especificada durante la creación de la cola o suscripción.

• Compruebe la lockedUntilUtc propiedad en el mensaje cuando expire el bloqueo.
• Si un mensaje no se resuelve (mediante complete(), defer() o deadletter(), antes de que expire su bloqueo, el mensaje vuelve a aparecer en la cola o suscripción para la siguiente operación de recepción.

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

Parámetros

message

ServiceBusReceivedMessage

Devoluciones

Promise<Date>

Nueva fecha y hora de expiración del token de bloqueo en formato UTC.

Heredado deServiceBusReceiver.renewMessageLock