TsgcWebSocketHTTPServerMethoden › Ping

Ping Methode

Sendet einen WebSocket-Ping-Frame an jeden verbundenen WebSocket-Client.

Syntax

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

Parameter

NameTypBeschreibung
aTextconst stringOptionale Payload, die im Ping-Frame mitgeführt wird; übergeben Sie einen leeren String, um einen Ping ohne Payload zu senden.

Hinweise

Ping iteriert die Liste der aktiven Verbindungen und sendet einen WebSocket-Ping-Frame an jeden hochgestuften Client, wobei er zurückkehrt, sobald die Frames an die zugrunde liegenden Sockets übergeben wurden. Reine HTTP-/HTTP2-Verbindungen werden übersprungen, da der WebSocket-Ping-Opcode nur nach einem erfolgreichen Handshake gilt. Es ist eine bequeme Möglichkeit, inaktive Verbindungen am Leben zu erhalten oder die Lebendigkeit zusätzlich zum automatischen HeartBeat-Mechanismus manuell zu prüfen. Wenn der HeartBeat-Timeout konfiguriert ist, schließt der Server jede Verbindung, die nicht innerhalb des Fensters antwortet; ohne Timeout ist der Aufruf "fire-and-forget" und alle Pong-Antworten werden asynchron über die Standard-Verbindungsereignisse zugestellt. Beim Schreiben ausgelöste Ausnahmen werden an OnException weitergeleitet.

Beispiel


oServer.Ping('keepalive');

Zurück zu Methoden