ServiceBusSessionReceiver interface

Paquet:

@azure/service-bus

Récepteur qui gère les sessions, y compris le renouvellement du verrou de session.

Extends

ServiceBusReceiver

Propriétés

sessionId	ID de la session.
sessionLockedUntilUtc	Heure UTC jusqu’à laquelle la session est verrouillée. Chaque fois renewSessionLock() qu’elle est appelée, cette heure est mise à jour à l’heure actuelle, plus la durée de verrouillage spécifiée lors de la création de la file d’attente/de l’abonnement. Retourne undefined jusqu’à ce qu’un lien de récepteur AMQP ait été correctement configuré pour la session.

Propriétés héritées

entityPath	Chemin de l’entité pour laquelle le récepteur a été créé.
identifier	Nom utilisé pour identifier le récepteur. Cela peut être utilisé pour mettre en corrélation les journaux et les exceptions. S’il n’est pas spécifié ou vide, un unique aléatoire est généré.
isClosed	Retourne true si le récepteur ou le client qui l’a créé a été fermé.
receiveMode	Mode de réception utilisé pour créer le récepteur.

Méthodes

getSessionState(OperationOptionsBase)	Obtient l’état de la session. Pour plus d’informations sur les états de session, consultez État de session
renewSessionLock(OperationOptionsBase)	Renouvelle le verrou sur la session.
setSessionState(any, OperationOptionsBase)	Définit l’état sur la session. Pour plus d’informations sur les états de session, consultez État de session
subscribe(MessageHandlers, SubscribeOptions)	Diffuse des messages vers des gestionnaires de messages.

Méthodes héritées

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Le verrou maintenu sur le message par le récepteur est lâché, ce qui rend le message à nouveau disponible dans Service Bus pour une autre opération de réception.
close()	Ferme le récepteur. Une fois fermé, le récepteur ne peut pas être utilisé pour d’autres opérations. Utilisez la createReceiver() méthode sur serviceBusClient pour créer un récepteur.
completeMessage(ServiceBusReceivedMessage)	Supprime le message de Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Déplace le message vers la sous-file d’attente deadletter. Pour recevoir un message avec lettres mortes, créez une nouvelle file d’attente QueueClient/SubscriptionClient à l’aide du chemin d’accès de la sous-file d’attente de lettres mortes.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Reporte le traitement du message. Enregistrez le sequenceNumber du message, afin de le recevoir à nouveau à l’avenir à l’aide de la receiveDeferredMessage méthode .
getMessageIterator(GetMessageIteratorOptions)	Retourne un itérateur qui peut être utilisé pour recevoir des messages de Service Bus.
peekMessages(number, PeekMessagesOptions)	Découvrez le lot suivant de messages actifs (y compris les messages différés, mais pas morts) sur la file d’attente ou l’abonnement sans les modifier. Le premier appel pour peekMessages() extraire le premier message actif. Chaque appel suivant extrait le message suivant. Contrairement à un message « reçu », le message « aperçu » est une version en lecture seule du message. Ne peut pas être Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Retourne une promesse qui se résout en un tableau de messages différés identifiés par donné sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Retourne une promesse qui se résout en un tableau de messages reçus à partir de Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Renouvelle le verrou sur le message pour la durée spécifiée lors de la création de la file d’attente/de l’abonnement. Vérifiez la lockedUntilUtc propriété sur le message pour l’heure à laquelle le verrou expire. Si un message n’est pas réglé (à l’aide complete()de , defer() ou deadletter(), avant l’expiration de son verrou, le message revient dans la file d’attente/abonnement pour l’opération de réception suivante.

Détails de la propriété

sessionId

ID de la session.

sessionId: string

Valeur de propriété

string

sessionLockedUntilUtc

Heure UTC jusqu’à laquelle la session est verrouillée. Chaque fois renewSessionLock() qu’elle est appelée, cette heure est mise à jour à l’heure actuelle, plus la durée de verrouillage spécifiée lors de la création de la file d’attente/de l’abonnement.

Retourne undefined jusqu’à ce qu’un lien de récepteur AMQP ait été correctement configuré pour la session.

sessionLockedUntilUtc: Date

Valeur de propriété

Date

Détails de la propriété héritée

entityPath

Chemin de l’entité pour laquelle le récepteur a été créé.

entityPath: string

Valeur de propriété

string

Hérité deServiceBusReceiver.entityPath

identifier

Nom utilisé pour identifier le récepteur. Cela peut être utilisé pour mettre en corrélation les journaux et les exceptions. S’il n’est pas spécifié ou vide, un unique aléatoire est généré.

identifier: string

Valeur de propriété

string

Hérité deServiceBusReceiver.identifier

isClosed

Retourne true si le récepteur ou le client qui l’a créé a été fermé.

isClosed: boolean

Valeur de propriété

boolean

Hérité deServiceBusReceiver.isClosed

receiveMode

Mode de réception utilisé pour créer le récepteur.

receiveMode: "peekLock" | "receiveAndDelete"

Valeur de propriété

"peekLock" | "receiveAndDelete"

Hérité deServiceBusReceiver.receiveMode

Détails de la méthode

getSessionState(OperationOptionsBase)

Obtient l’état de la session. Pour plus d’informations sur les états de session, consultez État de session

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

Paramètres

options

OperationOptionsBase

Sac d’options pour passer un signal d’abandon ou des options de traçage.

Retours

Promise<any>

État de cette session

renewSessionLock(OperationOptionsBase)

Renouvelle le verrou sur la session.

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

Paramètres

options

OperationOptionsBase

Retours

Promise<Date>

setSessionState(any, OperationOptionsBase)

Définit l’état sur la session. Pour plus d’informations sur les états de session, consultez État de session

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

Paramètres

state

any

État à définir.

options

OperationOptionsBase

Sac d’options pour passer un signal d’abandon ou des options de traçage.

Retours

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Diffuse des messages vers des gestionnaires de messages.

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

Paramètres

handlers

MessageHandlers

Gestionnaire qui est appelé pour les messages et les erreurs.

options

SubscribeOptions

Options d’abonnement.

Retours

{ close() => Promise<void> }

Objet qui peut être fermé, en envoyant les messages restants à handlers et en empêchant l’arrivée de nouveaux messages.

Détails de la méthode héritée

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

Le verrou maintenu sur le message par le récepteur est lâché, ce qui rend le message à nouveau disponible dans Service Bus pour une autre opération de réception.

function abandonMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

Paramètres

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

Propriétés du message à modifier lors de l’abandon du message.

Retours

Promise<void>

Hérité deServiceBusReceiver.abandonMessage

close()

Ferme le récepteur. Une fois fermé, le récepteur ne peut pas être utilisé pour d’autres opérations. Utilisez la createReceiver() méthode sur serviceBusClient pour créer un récepteur.

function close(): Promise<void>

Retours

Promise<void>

Hérité deServiceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

Supprime le message de Service Bus.

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

Paramètres

message

ServiceBusReceivedMessage

Retours

Promise<void>

Hérité deServiceBusReceiver.completeMessage

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

Déplace le message vers la sous-file d’attente deadletter. Pour recevoir un message avec lettres mortes, créez une nouvelle file d’attente QueueClient/SubscriptionClient à l’aide du chemin d’accès de la sous-file d’attente de lettres mortes.

function deadLetterMessage(message: ServiceBusReceivedMessage, options?: DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}): Promise<void>

Paramètres

message

ServiceBusReceivedMessage

options

DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}

Options DeadLetter qui peuvent être fournies lors du rejet du message.

Retours

Promise<void>

Hérité deServiceBusReceiver.deadLetterMessage

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

Reporte le traitement du message. Enregistrez le sequenceNumber du message, afin de le recevoir à nouveau à l’avenir à l’aide de la receiveDeferredMessage méthode .

function deferMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

Paramètres

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

Propriétés du message à modifier lors du report du message

Retours

Promise<void>

Hérité deServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

Retourne un itérateur qui peut être utilisé pour recevoir des messages de Service Bus.

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

Paramètres

options

GetMessageIteratorOptions

Ensemble d’options permettant de contrôler l’opération de réception.

• abortSignal: signal à utiliser pour abandonner l’opération en cours.

Retours

AsyncIterableIterator<ServiceBusReceivedMessage>

Hérité deServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Découvrez le lot suivant de messages actifs (y compris les messages différés, mais pas morts) sur la file d’attente ou l’abonnement sans les modifier.

• Le premier appel pour peekMessages() extraire le premier message actif. Chaque appel suivant extrait le message suivant.
• Contrairement à un message « reçu », le message « aperçu » est une version en lecture seule du message. Ne peut pas être Completed/Abandoned/Deferred/Deadlettered.

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

Paramètres

maxMessageCount

number

Nombre maximal de messages à lire.

options

PeekMessagesOptions

Options qui permettent de spécifier le nombre maximal de messages à consulter, le sequenceNumber à partir duquel commencer à consulter ou un abandonSignal pour abandonner l’opération.

Retours

Promise<ServiceBusReceivedMessage[]>

Héritée deServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Retourne une promesse qui se résout en un tableau de messages différés identifiés par donné sequenceNumbers.

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

Paramètres

sequenceNumbers

Long | Long[]

Numéro de séquence ou tableau de numéros de séquence pour les messages qui doivent être reçus.

options

OperationOptionsBase

Sac d’options pour passer un signal d’abandon ou des options de traçage.

Retours

Promise<ServiceBusReceivedMessage[]>

Liste de messages identifiés par le sequenceNumbers donné ou liste vide si aucun message n’est trouvé.

Hérité deServiceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

Retourne une promesse qui se résout en un tableau de messages reçus à partir de Service Bus.

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

Paramètres

maxMessageCount

number

Nombre maximal de messages à recevoir.

options

ReceiveMessagesOptions

Ensemble d’options permettant de contrôler l’opération de réception.

• maxWaitTimeInMs: durée maximale d’attente du premier message avant de retourner un tableau vide si aucun message n’est disponible.
• abortSignal: signal à utiliser pour abandonner l’opération en cours.

Retours

Promise<ServiceBusReceivedMessage[]>

Promesse qui se résout avec un tableau de messages.

Hérité deServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

Renouvelle le verrou sur le message pour la durée spécifiée lors de la création de la file d’attente/de l’abonnement.

• Vérifiez la lockedUntilUtc propriété sur le message pour l’heure à laquelle le verrou expire.
• Si un message n’est pas réglé (à l’aide complete()de , defer() ou deadletter(), avant l’expiration de son verrou, le message revient dans la file d’attente/abonnement pour l’opération de réception suivante.

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

Paramètres

message

ServiceBusReceivedMessage

Retours

Promise<Date>

Date et heure d’expiration du nouveau jeton de verrouillage au format UTC.

Hérité deServiceBusReceiver.renewMessageLock