TsgcWebSocketClient › Propriedades

Propriedades do TsgcWebSocketClient

Propriedades published agrupadas por finalidade, seguidas pela lista alfabética completa.

Conexão

NameDescrição
ActiveAbre ou fecha a conexão WebSocket com o servidor configurado.
HostEndereço IP ou nome DNS do servidor WebSocket ao qual o cliente se conectará.
PortPorta TCP usada para conectar ao servidor WebSocket.
URLAtalho somente escrita que preenche Host, Port, TLS e parâmetros a partir de uma única URL WebSocket.
TLSHabilita uma conexão TLS/SSL segura ao servidor WebSocket.
IPVersionSeleciona a versão do protocolo IP (IPv4 ou IPv6) usada para a conexão TCP.

Timeouts

NameDescrição
ConnectTimeoutTempo máximo em milissegundos que o cliente aguarda para que a conexão TCP seja estabelecida.
ReadTimeoutTempo máximo em milissegundos que o cliente aguarda por dados de entrada antes de gerar um timeout de leitura.
WriteTimeoutDuração máxima em milissegundos para enviar dados ao outro peer.

Confiabilidade

NameDescrição
HeartBeatEnvia frames de ping WebSocket periódicos para manter a conexão ativa.
WatchDogReconecta automaticamente ao servidor após uma desconexão inesperada.

Security

NameDescrição
ProxyRoteia a conexão WebSocket através de um servidor proxy HTTP ou SOCKS.
AuthenticationConfigura as credenciais e o esquema usados para autenticar o handshake WebSocket.
TLSOptionsConfigura certificados, versão de TLS, ALPN, IOHandler e outros detalhes de conexão segura usados quando o TLS está habilitado.

Messaging

NameDescrição
QueueOptionsEnfileira mensagens Text, Binary e Ping de saída para que sejam serializadas na thread da conexão.

Diagnósticos

NameDescrição
NotifyEventsControla como os eventos WebSocket são despachados para a thread principal.
LogFilePersiste o tráfego de socket de entrada e saída em um arquivo, útil para depurar o protocolo de fio.
VersionString somente leitura que retorna a versão atual da biblioteca sgcWebSockets.

Avançado

NameDescrição
ExtensionsHabilita extensões do protocolo WebSocket, como a compressão per-message deflate.
OptionsPersonaliza os cabeçalhos de handshake e ajusta finamente o comportamento do cliente, como fragmentação e validação UTF-8.
SpecificationsSeleciona quais especificações de fio WebSocket o cliente tem permissão para negociar.
ThrottleLimita o número de bits por segundo enviados ou recebidos pelo socket do cliente.

Outros

NameDescrição
LoadBalancerConecta-se a um servidor Load Balancer sgcWebSockets ou a um pool de servidores WebSocket definido manualmente.

Todas as Propriedades (alfabética)

NameDescrição
ActiveAbre ou fecha a conexão WebSocket com o servidor configurado.
AuthenticationConfigura as credenciais e o esquema usados para autenticar o handshake WebSocket.
ConnectTimeoutTempo máximo em milissegundos que o cliente aguarda para que a conexão TCP seja estabelecida.
ExtensionsHabilita extensões do protocolo WebSocket, como a compressão per-message deflate.
HeartBeatEnvia frames de ping WebSocket periódicos para manter a conexão ativa.
HostEndereço IP ou nome DNS do servidor WebSocket ao qual o cliente se conectará.
IPVersionSeleciona a versão do protocolo IP (IPv4 ou IPv6) usada para a conexão TCP.
LoadBalancerConecta-se a um servidor Load Balancer sgcWebSockets ou a um pool de servidores WebSocket definido manualmente.
LogFilePersiste o tráfego de socket de entrada e saída em um arquivo, útil para depurar o protocolo de fio.
NotifyEventsControla como os eventos WebSocket são despachados para a thread principal.
OptionsPersonaliza os cabeçalhos de handshake e ajusta finamente o comportamento do cliente, como fragmentação e validação UTF-8.
PortPorta TCP usada para conectar ao servidor WebSocket.
ProxyRoteia a conexão WebSocket através de um servidor proxy HTTP ou SOCKS.
QueueOptionsEnfileira mensagens Text, Binary e Ping de saída para que sejam serializadas na thread da conexão.
ReadTimeoutTempo máximo em milissegundos que o cliente aguarda por dados de entrada antes de gerar um timeout de leitura.
SpecificationsSeleciona quais especificações de fio WebSocket o cliente tem permissão para negociar.
ThrottleLimita o número de bits por segundo enviados ou recebidos pelo socket do cliente.
TLSHabilita uma conexão TLS/SSL segura ao servidor WebSocket.
TLSOptionsConfigura certificados, versão de TLS, ALPN, IOHandler e outros detalhes de conexão segura usados quando o TLS está habilitado.
URLAtalho somente escrita que preenche Host, Port, TLS e parâmetros a partir de uma única URL WebSocket.
VersionString somente leitura que retorna a versão atual da biblioteca sgcWebSockets.
WatchDogReconecta automaticamente ao servidor após uma desconexão inesperada.
WriteTimeoutDuração máxima em milissegundos para enviar dados ao outro peer.