TsgcWebSocketHTTPServer › Métodos › Ping
Envia um frame ping WebSocket a cada cliente WebSocket conectado.
procedure Ping(const aText: string = '');
| Name | Type | Descrição |
|---|---|---|
aText | const string | Payload opcional a ser transportado dentro do frame de ping; passe uma string vazia para enviar um ping sem payload. |
O Ping itera a lista de conexões ativas e envia um quadro de ping WebSocket a cada cliente que fez upgrade, retornando assim que os quadros são entregues aos sockets subjacentes. Conexões HTTP/HTTP2 simples são ignoradas porque o opcode de ping WebSocket só se aplica após um handshake bem-sucedido. É uma forma conveniente de manter conexões ociosas ativas ou de sondar a vitalidade manualmente, além do mecanismo automático de HeartBeat. Quando o timeout de HeartBeat está configurado, o servidor fecha qualquer conexão que não responda dentro da janela; sem um timeout, a chamada é fire-and-forget e quaisquer respostas pong são entregues de forma assíncrona por meio dos eventos de conexão padrão. As exceções geradas durante a escrita são roteadas para OnException.
oServer.Ping('keepalive');