TsgcWebSocketHTTPServerMethoden › Ping

Ping Methode

Verzendt een WebSocket-ping-frame naar elke verbonden WebSocket-client.

Syntaxis

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

Parameters

NaamTypeBeschrijving
aTextconst stringOptionele payload in het ping-frame; geef een lege tekenreeks door om een ping zonder payload te verzenden.

Opmerkingen

Ping doorloopt de actieve verbindingslijst en verzendt een WebSocket-pingframe naar elke bijgewerkte client en keert terug zodra de frames zijn overgedragen aan de onderliggende sockets. Gewone HTTP/HTTP2-verbindingen worden overgeslagen omdat de WebSocket-pingopcode alleen van toepassing is na een succesvolle handshake. Het is een handige manier om inactieve verbindingen actief te houden of de activiteit handmatig te testen naast het automatische HeartBeat-mechanisme. Wanneer de HeartBeat-timeout is geconfigureerd, sluit de server elke verbinding die niet binnen het venster antwoordt; zonder timeout is de aanroep fire-and-forget en worden eventuele pong-antwoorden asynchroon geleverd via de standaardverbindingsgebeurtenissen. Uitzonderingen die optreden bij het schrijven worden doorgestuurd naar OnException.

Voorbeeld


oServer.Ping('keepalive');

Terug naar methoden