ServiceBusSessionReceiverOptions interface

Paquet:

@azure/service-bus

Décrit les options passées aux méthodes et acceptNextSession lors de l’utilisation acceptSession d’une file d’attente/abonnement pour laquelle les sessions sont activées.

Extends

OperationOptionsBase

Propriétés

identifier	Définit le nom pour identifier le récepteur de session. 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 utilisé.
maxAutoLockRenewalDurationInMs	Durée maximale, en millisecondes, pendant laquelle le verrou de la session sera renouvelé automatiquement par le client. Valeur par défaut : 300000 millisecondes (5 minutes). Pour désactiver le renouvellement de verrouillage automatique, définissez ce paramètre sur 0. Exemple : Si le verrou expire dans 2 minutes et que votre temps de traitement est de 8 minutes... Définissez maxAutoLockRenewalDurationInMs sur 10 minutes, et le verrou sera automatiquement renouvelé environ 4 fois (ce qui équivaut à avoir la session verrouillée pendant 4 fois sa durée de verrouillage en tirant parti des renouvellements de verrous).
receiveMode	Représente le mode de réception pour le récepteur. En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus. En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente/l’abonnement. Les messages qui ne sont pas réglés pendant la durée de verrouillage sont réélisés autant de fois que le nombre maximal de remises défini sur la file d’attente/l’abonnement, après quoi ils sont envoyés à une file d’attente distincte de lettres mortes. Vous pouvez régler un message en appelant les méthodes complete(), abandon(), defer() ou deadletter() sur le message. Pour plus d’informations sur le fonctionnement de peekLock et du règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	Indique s’il faut ignorer la conversion du type Date sur les propriétés des annotations de message ou des propriétés d’application en nombres lors de la réception du message. Par défaut, les propriétés de type Date sont converties en nombre d’époque UNIX à des fins de compatibilité.
skipParsingBodyAsJson	Option permettant de désactiver le client d’exécuter JSON.parse() sur le corps du message lors de la réception du message. Non applicable si le message a été envoyé avec une valeur ou une séquence de type de corps AMQP. Utilisez cette option lorsque vous préférez travailler directement avec les octets présents dans le corps du message plutôt que d’avoir le client à tenter de l’analyser.

Propriétés héritées

abortSignal	Signal qui peut être utilisé pour abandonner les demandes.
tracingOptions	Options utilisées lorsque le traçage est activé.

Détails de la propriété

identifier

Définit le nom pour identifier le récepteur de session. 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 utilisé.

identifier?: string

Valeur de propriété

string

maxAutoLockRenewalDurationInMs

Durée maximale, en millisecondes, pendant laquelle le verrou de la session sera renouvelé automatiquement par le client.

• Valeur par défaut : 300000 millisecondes (5 minutes).
• Pour désactiver le renouvellement de verrouillage automatique, définissez ce paramètre sur 0.

Exemple :

Si le verrou expire dans 2 minutes et que votre temps de traitement est de 8 minutes...

Définissez maxAutoLockRenewalDurationInMs sur 10 minutes, et le verrou sera automatiquement renouvelé environ 4 fois (ce qui équivaut à avoir la session verrouillée pendant 4 fois sa durée de verrouillage en tirant parti des renouvellements de verrous).

maxAutoLockRenewalDurationInMs?: number

Valeur de propriété

number

receiveMode

Représente le mode de réception pour le récepteur.

En mode receiveAndDelete, les messages sont supprimés de Service Bus à mesure qu’ils sont reçus.

En mode peekLock, le récepteur dispose d’un verrou sur le message pendant la durée spécifiée dans la file d’attente/l’abonnement.

Les messages qui ne sont pas réglés pendant la durée de verrouillage sont réélisés autant de fois que le nombre maximal de remises défini sur la file d’attente/l’abonnement, après quoi ils sont envoyés à une file d’attente distincte de lettres mortes.

Vous pouvez régler un message en appelant les méthodes complete(), abandon(), defer() ou deadletter() sur le message.

Pour plus d’informations sur le fonctionnement de peekLock et du règlement des messages, cliquez ici : https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Valeur de propriété

"peekLock" | "receiveAndDelete"

skipConvertingDate

Indique s’il faut ignorer la conversion du type Date sur les propriétés des annotations de message ou des propriétés d’application en nombres lors de la réception du message. Par défaut, les propriétés de type Date sont converties en nombre d’époque UNIX à des fins de compatibilité.

skipConvertingDate?: boolean

Valeur de propriété

boolean

skipParsingBodyAsJson

Option permettant de désactiver le client d’exécuter JSON.parse() sur le corps du message lors de la réception du message. Non applicable si le message a été envoyé avec une valeur ou une séquence de type de corps AMQP. Utilisez cette option lorsque vous préférez travailler directement avec les octets présents dans le corps du message plutôt que d’avoir le client à tenter de l’analyser.

skipParsingBodyAsJson?: boolean

Valeur de propriété

boolean

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

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

Hérité de OperationOptionsBase.abortSignal

tracingOptions

Options utilisées lorsque le traçage est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

Hérité de OperationOptionsBase.tracingOptions