ServiceBusReceiverOptions interface
Options à utiliser lors de la création d’un récepteur.
Propriétés
| identifier | Définit le nom 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 utilisé. |
| max |
Durée maximale, en millisecondes, pendant laquelle le verrou sur le message sera renouvelé automatiquement par le client. Ce renouvellement automatique s’arrête une fois le message réglé.
Exemple : Si le verrou de message expire dans 2 minutes et que le temps de traitement de votre message est de 8 minutes... Définissez maxAutoLockRenewalDurationInMs sur 10 minutes, et le verrou de message sera automatiquement renouvelé 4 fois (ce qui équivaut à avoir le message verrouillé pendant 4 fois sa durée de verrouillage en tirant parti des renouvellements de verrou). |
| receive |
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 |
| skip |
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é. |
| skip |
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. |
| sub |
Représente la sous-file d’attente applicable à toute file d’attente ou abonnement. Les valeurs valides sont « deadLetter » et « transferDeadLetter ». Pour en savoir plus sur les files d’attente de lettres mortes, consultez https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues |
Détails de la propriété
identifier
Définit le nom 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 utilisé.
identifier?: stringValeur de propriété
string
maxAutoLockRenewalDurationInMs
Durée maximale, en millisecondes, pendant laquelle le verrou sur le message sera renouvelé automatiquement par le client. Ce renouvellement automatique s’arrête une fois le message réglé.
-
Valeur par défaut :
300 * 1000millisecondes (5 minutes). -
Pour désactiver le renouvellement de verrouillage automatique, définissez ce paramètre sur
0.
Exemple :
Si le verrou de message expire dans 2 minutes et que le temps de traitement de votre message est de 8 minutes...
Définissez maxAutoLockRenewalDurationInMs sur 10 minutes, et le verrou de message sera automatiquement renouvelé 4 fois (ce qui équivaut à avoir le message verrouillé pendant 4 fois sa durée de verrouillage en tirant parti des renouvellements de verrou).
maxAutoLockRenewalDurationInMs?: numberValeur 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?: booleanValeur 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?: booleanValeur de propriété
boolean
subQueueType
Représente la sous-file d’attente applicable à toute file d’attente ou abonnement. Les valeurs valides sont « deadLetter » et « transferDeadLetter ». Pour en savoir plus sur les files d’attente de lettres mortes, consultez https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues
subQueueType?: "deadLetter" | "transferDeadLetter"Valeur de propriété
"deadLetter" | "transferDeadLetter"