TsgcWebSocketHTTPServer › Méthodes › Ping
Envoie une trame ping WebSocket à chaque client WebSocket connecté.
procedure Ping(const aText: string = '');| Nom | Type | Description |
|---|---|---|
aText | const string | Charge utile optionnelle à transporter dans la trame ping ; passez une chaîne vide pour envoyer un ping sans charge utile. |
Ping itère la liste des connexions actives et envoie une trame ping WebSocket à chaque client mis à niveau, retournant une fois les trames transmises aux sockets sous-jacents. Les connexions HTTP/HTTP2 brutes sont ignorées car l'opcode ping WebSocket s'applique uniquement après un handshake réussi. C'est un moyen pratique de maintenir les connexions inactives en vie ou de sonder manuellement la disponibilité en plus du mécanisme automatique HeartBeat. Lorsque le délai HeartBeat est configuré, le serveur ferme toute connexion qui ne répond pas dans la fenêtre ; sans délai, l'appel est de type « fire-and-forget » et les réponses pong sont livrées de manière asynchrone via les événements de connexion standard. Les exceptions levées lors de l'écriture sont transmises à OnException.
oServer.Ping('keepalive');