TsgcWebSocketServerMétodos › Ping

Ping Method

Envia um frame WebSocket ping para cada cliente conectado.

Sintaxe

procedure Ping(const aText: string = '');

Parâmetros

NameTypeDescrição
aTextconst stringPayload opcional a ser transportado dentro do frame de ping; passe uma string vazia para enviar um ping sem payload.

Observações

Ping itera a lista de conexões ativas e envia um frame de ping WebSocket para cada cliente, retornando assim que os frames são entregues aos sockets subjacentes. É uma forma conveniente de manter conexões ociosas ativas ou de sondar manualmente a vitalidade, além do mecanismo automático de HeartBeat. Quando o timeout do HeartBeat está configurado, o servidor fecha qualquer conexão que não responda dentro da janela; sem um timeout, a chamada é do tipo fire-and-forget e quaisquer respostas pong são entregues de forma assíncrona por meio dos eventos de conexão padrão. Exceções geradas durante a escrita são roteadas para OnException.

Exemplo


oServer.Ping('keepalive');

Voltar para Métodos