WebPubSubClientOptions interface

Paquet:

@azure/web-pubsub-client

Options du client

Propriétés

autoReconnect	Indique s’il faut se reconnecter automatiquement une fois la connexion supprimée et non récupérable
autoRejoinGroups	Indique s’il faut activer la restauration du groupe après la reconnexion
keepAliveIntervalInMs	L’intervalle en millisecondes auquel envoyer les messages de ping keep-alive au runtime. Par défaut, c’est 20000ms (20 secondes). Réglez à 0 pour désactiver les pings de maintien en vie initiés par le client. Doit être supérieur ou égal à 0. Nous recommandons de choisir une valeur inférieure à keepAliveTimeoutInMs (encore une fois, environ 3 fois plus basse) afin que le délai ne se déclenche que lorsque plusieurs pings échouent.
keepAliveTimeoutInMs	Le délai d’attente en millisecondes utilisé pour détecter les connexions à moitié ouvertes lorsqu’aucune donnée ou pong n’a été reçu. Par défaut, c’est 120000 ms (120 secondes). Réglez à 0 pour désactiver ce contrôle de timeout. Doit être supérieur ou égal à 0. Nous recommandons de garder cette valeur confortablement supérieure à keepAliveIntervalInMs (par exemple 3x) afin que les sondes aient le temps de fonctionner avant que le délai d’expiration ne ferme la socket.
messageRetryOptions	Options de nouvelle tentative pour les opérations telles que la jonction de groupe et l’envoi de messages
protocol	Sous-protocole
reconnectRetryOptions	Options de nouvelle tentative de reconnexion. Disponible uniquement lorsque la connexion automatique est vraie.

Détails de la propriété

autoReconnect

Indique s’il faut se reconnecter automatiquement une fois la connexion supprimée et non récupérable

autoReconnect?: boolean

Valeur de propriété

boolean

autoRejoinGroups

Indique s’il faut activer la restauration du groupe après la reconnexion

autoRejoinGroups?: boolean

Valeur de propriété

boolean

keepAliveIntervalInMs

L’intervalle en millisecondes auquel envoyer les messages de ping keep-alive au runtime. Par défaut, c’est 20000ms (20 secondes). Réglez à 0 pour désactiver les pings de maintien en vie initiés par le client. Doit être supérieur ou égal à 0. Nous recommandons de choisir une valeur inférieure à keepAliveTimeoutInMs (encore une fois, environ 3 fois plus basse) afin que le délai ne se déclenche que lorsque plusieurs pings échouent.

keepAliveIntervalInMs?: number

Valeur de propriété

number

keepAliveTimeoutInMs

Le délai d’attente en millisecondes utilisé pour détecter les connexions à moitié ouvertes lorsqu’aucune donnée ou pong n’a été reçu. Par défaut, c’est 120000 ms (120 secondes). Réglez à 0 pour désactiver ce contrôle de timeout. Doit être supérieur ou égal à 0. Nous recommandons de garder cette valeur confortablement supérieure à keepAliveIntervalInMs (par exemple 3x) afin que les sondes aient le temps de fonctionner avant que le délai d’expiration ne ferme la socket.

keepAliveTimeoutInMs?: number

Valeur de propriété

number

messageRetryOptions

Options de nouvelle tentative pour les opérations telles que la jonction de groupe et l’envoi de messages

messageRetryOptions?: WebPubSubRetryOptions

Valeur de propriété

WebPubSubRetryOptions

protocol

Sous-protocole

protocol?: WebPubSubClientProtocol

Valeur de propriété

WebPubSubClientProtocol

reconnectRetryOptions

Options de nouvelle tentative de reconnexion. Disponible uniquement lorsque la connexion automatique est vraie.

reconnectRetryOptions?: WebPubSubRetryOptions

Valeur de propriété

WebPubSubRetryOptions