TsgcWebSocketServer_HTTPAPI › Propriedades

TsgcWebSocketServer_HTTPAPI Properties

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

Conexão

NameDescrição
ActiveInicia ou para o listener HTTP.sys, registrando a URL configurada no driver do kernel do Windows.
HostHostname ou endereço IP utilizado para construir a URL registrada com o driver http.sys.
PortPorta TCP que, combinada com Host, forma a URL que o driver http.sys reserva para o servidor.
BindingOptionsAjusta como as reservas de URL e os certificados SSL são registrados com o driver http.sys na inicialização.
MaxConnectionsNúmero máximo de conexões de cliente concorrentes aceitas pelo listener http.sys (zero significa ilimitado).

Timeouts

NameDescrição
TimeoutsSubstitui os timeouts padrão do http.sys de requisição, corpo da entidade, keep-alive e taxa de envio.

Security

NameDescrição
AuthenticationHabilita e configura a autenticação por usuário/senha para requisições WebSocket e HTTP de entrada.
SSLHabilita TLS/SSL no listener do http.sys para que os clientes possam conectar-se utilizando wss:// ou https://.
SSLOptionsIdentifica a entrada do Windows Certificate Store que o http.sys vincula ao listener quando o SSL está habilitado.
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 WebSocket ociosas ativas e detectar peers mortos.
WatchDogReinicia automaticamente o servidor após um desligamento inesperado ou falha do listener.
FirewallAtribui um componente de firewall que filtra conexões recebidas por IP, região ou regras personalizadas.
RateLimiterAtribui um componente de rate-limiter que limita as taxas de requisição e de mensagem por cliente ou por IP.

Desempenho

NameDescrição
AsynchronousHabilita envios fire-and-forget: o chamador retorna imediatamente e a conclusão é sinalizada através do evento OnAsynchronous.
MaxBandwidthLargura de banda máxima permitida em bytes por segundo em todas as conexões (zero significa ilimitado).
ThreadPoolSizeNúmero de worker threads atendendo a fila de requisições do http.sys por meio de IOCP.
ReadBufferSizeTamanho em bytes do buffer de recepção alocado por leitura overlapped pendente na fila de requisições do http.sys.
FineTuneAjustes de baixo nível em modo kernel que moldam como o http.sys enfileira, despacha e completa requisições.

HTTP

NameDescrição
HTTPUploadFilesControla como os arquivos enviados por HTTP POST são armazenados em buffer (memória ou fluxo de arquivo) e salvos em disco.

Avançado

NameDescrição
OptionsAgrupa flags diversas de comportamento do servidor: tratamento de fragmentos, write 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á.

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.
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 listener HTTP.sys, registrando a URL configurada no driver do kernel do Windows.
APIKeyManagerComponente gerenciador de chaves de API opcional utilizado para validar chaves de API de entrada antes de aceitar uma conexão.
AsynchronousHabilita envios fire-and-forget: o chamador retorna imediatamente e a conclusão é sinalizada através do evento OnAsynchronous.
AuthenticationHabilita e configura a autenticação por usuário/senha para requisições WebSocket e HTTP de entrada.
BindingOptionsAjusta como as reservas de URL e os certificados SSL são registrados com o driver http.sys na inicialização.
ExtensionsConfigura extensões do protocolo WebSocket, como a compressão per-message deflate.
FineTuneAjustes de baixo nível em modo kernel que moldam como o http.sys enfileira, despacha e completa requisições.
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 WebSocket ociosas ativas e detectar peers mortos.
HostHostname ou endereço IP utilizado para construir a URL registrada com o driver http.sys.
HTTPUploadFilesControla como os arquivos enviados por HTTP POST são armazenados em buffer (memória ou fluxo de arquivo) e salvos em disco.
LogFileEscreve cada mensagem de socket de entrada e de saída em um arquivo de log para depuração e auditoria.
MaxBandwidthLargura de banda máxima permitida em bytes por segundo em todas as conexões (zero significa ilimitado).
MaxConnectionsNúmero máximo de conexões de cliente concorrentes aceitas pelo listener http.sys (zero significa ilimitado).
OptionsAgrupa flags diversas de comportamento do servidor: tratamento de fragmentos, write timeouts, páginas de teste HTTP e validação UTF-8.
PortPorta TCP que, combinada com Host, forma a URL que o driver http.sys reserva para o servidor.
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.
ReadBufferSizeTamanho em bytes do buffer de recepção alocado por leitura overlapped pendente na fila de requisições do http.sys.
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 listener do http.sys para que os clientes possam conectar-se utilizando wss:// ou https://.
SSLOptionsIdentifica a entrada do Windows Certificate Store que o http.sys vincula ao listener quando o SSL está habilitado.
ThreadPoolSizeNúmero de worker threads atendendo a fila de requisições do http.sys por meio de IOCP.
TimeoutsSubstitui os timeouts padrão do http.sys de requisição, corpo da entidade, keep-alive e taxa de envio.
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.