WebPubSubClientOptions interface

Paquete:: @azure/web-pubsub-client

Opciones de cliente

Propiedades

autoReconnect	Si se va a volver a conectar automáticamente después de quitar la conexión y no se puede recuperar
autoRejoinGroups	Si se va a habilitar la restauración del grupo después de volver a conectarse
keepAliveIntervalInMs	El intervalo en milisegundos al que enviar mensajes de ping de mantenimiento vivo al tiempo de ejecución. El valor predeterminado es 20000ms (20 segundos). Configura a 0 para desactivar los pings de mantenimiento en vivo iniciados por el cliente. Debe ser mayor o igual que 0. Recomendamos elegir un valor menor que `keepAliveTimeoutInMs` (de nuevo, aproximadamente 3 veces menor) para que el tiempo de espera solo se active cuando fallen varios pings.
keepAliveTimeoutInMs	El tiempo de espera en milisegundos se usa para detectar conexiones medio abiertas cuando no se ha recibido ningún dato o pong. El valor predeterminado es 120000 ms (120 segundos). Ponlo en 0 para desactivar esta comprobación de tiempo de espera. Debe ser mayor o igual que 0. Recomendamos mantener este valor cómodamente mayor que `keepAliveIntervalInMs` (por ejemplo, 3x) para que las sondas tengan tiempo de funcionar antes de que el tiempo de espera cierre el socket.
messageRetryOptions	Las opciones de reintento para operaciones como unirse al grupo y enviar mensajes
protocol	Subprotocolo
reconnectRetryOptions	Las opciones de reintento para la reconexión. Solo está disponible cuando autoReconnect es true.

Detalles de las propiedades

autoReconnect

Si se va a volver a conectar automáticamente después de quitar la conexión y no se puede recuperar

autoReconnect?: boolean

Valor de propiedad

boolean

autoRejoinGroups

Si se va a habilitar la restauración del grupo después de volver a conectarse

autoRejoinGroups?: boolean

Valor de propiedad

boolean

keepAliveIntervalInMs

El intervalo en milisegundos al que enviar mensajes de ping de mantenimiento vivo al tiempo de ejecución. El valor predeterminado es 20000ms (20 segundos). Configura a 0 para desactivar los pings de mantenimiento en vivo iniciados por el cliente. Debe ser mayor o igual que 0. Recomendamos elegir un valor menor que keepAliveTimeoutInMs (de nuevo, aproximadamente 3 veces menor) para que el tiempo de espera solo se active cuando fallen varios pings.

keepAliveIntervalInMs?: number

Valor de propiedad

number

keepAliveTimeoutInMs

El tiempo de espera en milisegundos se usa para detectar conexiones medio abiertas cuando no se ha recibido ningún dato o pong. El valor predeterminado es 120000 ms (120 segundos). Ponlo en 0 para desactivar esta comprobación de tiempo de espera. Debe ser mayor o igual que 0. Recomendamos mantener este valor cómodamente mayor que keepAliveIntervalInMs (por ejemplo, 3x) para que las sondas tengan tiempo de funcionar antes de que el tiempo de espera cierre el socket.

keepAliveTimeoutInMs?: number

Valor de propiedad

number

messageRetryOptions

Las opciones de reintento para operaciones como unirse al grupo y enviar mensajes

messageRetryOptions?: WebPubSubRetryOptions

Valor de propiedad

WebPubSubRetryOptions

protocol

Subprotocolo

protocol?: WebPubSubClientProtocol

Valor de propiedad

WebPubSubClientProtocol

reconnectRetryOptions

Las opciones de reintento para la reconexión. Solo está disponible cuando autoReconnect es true.

reconnectRetryOptions?: WebPubSubRetryOptions

Valor de propiedad

WebPubSubRetryOptions