TsgcWebSocketClient › Propiedades

Propiedades de TsgcWebSocketClient

Propiedades publicadas agrupadas por propósito, seguidas de la lista alfabética completa.

Conexión

NombreDescripción
ActiveAbre o cierra la conexión WebSocket con el servidor configurado.
HostDirección IP o nombre DNS del servidor WebSocket al que se conectará el cliente.
PortPuerto TCP utilizado para conectarse al servidor WebSocket.
URLAcceso directo de solo escritura que rellena Host, Port, TLS y parámetros a partir de una única URL de WebSocket.
TLSHabilita una conexión TLS/SSL segura al servidor WebSocket.
IPVersionSelecciona la versión del protocolo IP (IPv4 o IPv6) utilizada para la conexión TCP.

Tiempos de espera

NombreDescripción
ConnectTimeoutTiempo máximo en milisegundos que el cliente espera a que se establezca la conexión TCP.
ReadTimeoutTiempo máximo en milisegundos que el cliente espera datos entrantes antes de generar un error de tiempo de espera de lectura.
WriteTimeoutDuración máxima en milisegundos para el envío de datos al otro par.

Fiabilidad

NombreDescripción
HeartBeatEnvía frames ping periódicos de WebSocket para mantener activa la conexión.
WatchDogSe reconecta automáticamente al servidor tras una desconexión inesperada.

Seguridad

NombreDescripción
ProxyEnruta la conexión WebSocket a través de un servidor proxy HTTP o SOCKS.
AuthenticationConfigura las credenciales y el esquema usados para autenticar el handshake de WebSocket.
TLSOptionsConfigura certificados, versión TLS, ALPN, IOHandler y otros detalles de conexión segura utilizados cuando TLS está habilitado.

Mensajería

NombreDescripción
QueueOptionsPone en cola los mensajes salientes de tipo texto, binario y Ping para serializarlos en el hilo de la conexión.

Diagnósticos

NombreDescripción
NotifyEventsControla cómo se despachan los eventos WebSocket al hilo principal.
LogFilePersiste el tráfico de socket entrante y saliente en un archivo, lo cual es útil para depurar el protocolo a nivel de wire.
VersionCadena de solo lectura que devuelve la versión actual de la biblioteca sgcWebSockets.

Avanzado

NombreDescripción
ExtensionsHabilita extensiones del protocolo WebSocket, como la compresión por deflate de mensaje.
OptionsPersonaliza las cabeceras de negociación y ajusta el comportamiento del cliente, como la fragmentación y la validación de UTF-8.
EspecificacionesSelecciona qué especificaciones del protocolo WebSocket puede negociar el cliente.
ThrottleLimita el número de bits por segundo enviados o recibidos por el socket del cliente.

Otros

NombreDescripción
LoadBalancerSe conecta a un servidor del balanceador de carga de sgcWebSockets o a un conjunto de servidores WebSocket definido manualmente.

Todas las Propiedades (alfabético)

NombreDescripción
ActiveAbre o cierra la conexión WebSocket con el servidor configurado.
AuthenticationConfigura las credenciales y el esquema usados para autenticar el handshake de WebSocket.
ConnectTimeoutTiempo máximo en milisegundos que el cliente espera a que se establezca la conexión TCP.
ExtensionsHabilita extensiones del protocolo WebSocket, como la compresión por deflate de mensaje.
HeartBeatEnvía frames ping periódicos de WebSocket para mantener activa la conexión.
HostDirección IP o nombre DNS del servidor WebSocket al que se conectará el cliente.
IPVersionSelecciona la versión del protocolo IP (IPv4 o IPv6) utilizada para la conexión TCP.
LoadBalancerSe conecta a un servidor del balanceador de carga de sgcWebSockets o a un conjunto de servidores WebSocket definido manualmente.
LogFilePersiste el tráfico de socket entrante y saliente en un archivo, lo cual es útil para depurar el protocolo a nivel de wire.
NotifyEventsControla cómo se despachan los eventos WebSocket al hilo principal.
OptionsPersonaliza las cabeceras de negociación y ajusta el comportamiento del cliente, como la fragmentación y la validación de UTF-8.
PortPuerto TCP utilizado para conectarse al servidor WebSocket.
ProxyEnruta la conexión WebSocket a través de un servidor proxy HTTP o SOCKS.
QueueOptionsPone en cola los mensajes salientes de tipo texto, binario y Ping para serializarlos en el hilo de la conexión.
ReadTimeoutTiempo máximo en milisegundos que el cliente espera datos entrantes antes de generar un error de tiempo de espera de lectura.
EspecificacionesSelecciona qué especificaciones del protocolo WebSocket puede negociar el cliente.
ThrottleLimita el número de bits por segundo enviados o recibidos por el socket del cliente.
TLSHabilita una conexión TLS/SSL segura al servidor WebSocket.
TLSOptionsConfigura certificados, versión TLS, ALPN, IOHandler y otros detalles de conexión segura utilizados cuando TLS está habilitado.
URLAcceso directo de solo escritura que rellena Host, Port, TLS y parámetros a partir de una única URL de WebSocket.
VersionCadena de solo lectura que devuelve la versión actual de la biblioteca sgcWebSockets.
WatchDogSe reconecta automáticamente al servidor tras una desconexión inesperada.
WriteTimeoutDuración máxima en milisegundos para el envío de datos al otro par.