TsgcWebSocketServer › Propriedades

TsgcWebSocketServer Properties

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

Conexão

NameDescrição
ActiveInicia ou para o servidor, abrindo os sockets de escuta nos bindings configurados.
PortPorta TCP na qual o servidor aceita conexões WebSocket e HTTP de entrada.
BindingsColeção de pares IP/Porta nos quais o servidor escuta; utilize-a para vincular vários endpoints simultaneamente.
MaxConnectionsNúmero máximo de conexões de cliente simultâneas aceitas pelo servidor.

Security

NameDescrição
AuthenticationHabilita e configura a autenticação de usuário/senha para conexões WebSocket e HTTP de entrada.
SSLHabilita TLS/SSL no servidor para que os clientes possam conectar usando wss:// ou https://.
SSLOptionsMantém os caminhos de certificado, a seleção de versão TLS e o ajuste OpenSSL para o listener TLS.
SecurityOptionsDefine regras de admissão, como origens permitidas para handshakes WebSocket de navegador.
APIKeyManagerComponente gerenciador de chaves de API opcional utilizado para validar chaves de API de entrada antes de aceitar uma conexão.

Confiabilidade

NameDescrição
HeartBeatEnvia frames de ping periódicos para manter conexões de cliente ociosas ativas e detectar peers mortos.
WatchDogReinicia automaticamente o servidor após um desligamento inesperado ou falha do listener.
LoadBalancerConfigura o cliente integrado usado para registrar este servidor em uma instância de Load Balancer Server.
FallBackFornece transportes alternativos para navegadores que não suportam WebSockets nativos.
RateLimiterAtribui um componente de rate-limiter que limita as taxas de requisição e de mensagem por cliente ou por IP.
FirewallAtribui um componente de firewall que filtra conexões recebidas por IP, região ou regras personalizadas.

Avançado

NameDescrição
OptionsAgrupa flags diversas de comportamento do servidor: tratamento de fragmentos, timeouts, páginas de teste HTTP e validação UTF-8.
QueueOptionsSerializa as mensagens de saída através de uma fila interna por conexão para evitar contenção entre threads.
ExtensionsConfigura extensões do protocolo WebSocket, como a compressão per-message deflate.
SpecificationsHabilita ou desabilita as especificações do protocolo WebSocket que o servidor aceitará.
HTTP2OptionsHabilita e ajusta o handler do protocolo HTTP/2 utilizado para servir requisições HTTPS.
IOHandlerOptionsSeleciona a estratégia de I/O utilizada para atender às conexões: thread-per-connection, IOCP ou EPOLL.
ThreadPoolHabilita um pool de threads que recicla os threads de trabalho em vez de destruí-los quando as conexões são fechadas.
ThreadPoolOptionsConfigura o tamanho e o limite superior do pool de threads reutilizável.
ThrottleLimita a largura de banda (bits por segundo) que o servidor lê de ou grava em cada conexão.

Diagnósticos

NameDescrição
LogFileEscreve cada mensagem de socket de entrada e de saída em um arquivo de log para depuração e auditoria.
NotifyEventsControla como os eventos WebSocket por thread são sincronizados com o thread VCL principal.
VersionString somente leitura com a versão da biblioteca sgcWebSockets embutida no binário.

Todas as Propriedades (alfabética)

NameDescrição
ActiveInicia ou para o servidor, abrindo os sockets de escuta nos bindings configurados.
APIKeyManagerComponente gerenciador de chaves de API opcional utilizado para validar chaves de API de entrada antes de aceitar uma conexão.
AuthenticationHabilita e configura a autenticação de usuário/senha para conexões WebSocket e HTTP de entrada.
BindingsColeção de pares IP/Porta nos quais o servidor escuta; utilize-a para vincular vários endpoints simultaneamente.
ExtensionsConfigura extensões do protocolo WebSocket, como a compressão per-message deflate.
FallBackFornece transportes alternativos para navegadores que não suportam WebSockets nativos.
FirewallAtribui um componente de firewall que filtra conexões recebidas por IP, região ou regras personalizadas.
HeartBeatEnvia frames de ping periódicos para manter conexões de cliente ociosas ativas e detectar peers mortos.
HTTP2OptionsHabilita e ajusta o handler do protocolo HTTP/2 utilizado para servir requisições HTTPS.
IOHandlerOptionsSeleciona a estratégia de I/O utilizada para atender às conexões: thread-per-connection, IOCP ou EPOLL.
LoadBalancerConfigura o cliente integrado usado para registrar este servidor em uma instância de Load Balancer Server.
LogFileEscreve cada mensagem de socket de entrada e de saída em um arquivo de log para depuração e auditoria.
MaxConnectionsNúmero máximo de conexões de cliente simultâneas aceitas pelo servidor.
NotifyEventsControla como os eventos WebSocket por thread são sincronizados com o thread VCL principal.
OptionsAgrupa flags diversas de comportamento do servidor: tratamento de fragmentos, timeouts, páginas de teste HTTP e validação UTF-8.
PortPorta TCP na qual o servidor aceita conexões WebSocket e HTTP de entrada.
QueueOptionsSerializa as mensagens de saída através de uma fila interna por conexão para evitar contenção entre threads.
RateLimiterAtribui um componente de rate-limiter que limita as taxas de requisição e de mensagem por cliente ou por IP.
SecurityOptionsDefine regras de admissão, como origens permitidas para handshakes WebSocket de navegador.
SpecificationsHabilita ou desabilita as especificações do protocolo WebSocket que o servidor aceitará.
SSLHabilita TLS/SSL no servidor para que os clientes possam conectar usando wss:// ou https://.
SSLOptionsMantém os caminhos de certificado, a seleção de versão TLS e o ajuste OpenSSL para o listener TLS.
ThreadPoolHabilita um pool de threads que recicla os threads de trabalho em vez de destruí-los quando as conexões são fechadas.
ThreadPoolOptionsConfigura o tamanho e o limite superior do pool de threads reutilizável.
ThrottleLimita a largura de banda (bits por segundo) que o servidor lê de ou grava em cada conexão.
VersionString somente leitura com a versão da biblioteca sgcWebSockets embutida no binário.
WatchDogReinicia automaticamente o servidor após um desligamento inesperado ou falha do listener.