TsgcWebSocketServerMethods › Ping

Ping Methode

Sendet einen WebSocket-Ping-Frame an jeden verbundenen 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 durchläuft die Liste der aktiven Verbindungen und sendet einen WebSocket-Ping-Frame an jeden Client, wobei der Vorgang zurückkehrt, sobald die Frames an die zugrunde liegenden Sockets übergeben wurden. Es ist eine bequeme Möglichkeit, untätige Verbindungen am Leben zu erhalten oder die Erreichbarkeit 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 Zeitfensters antwortet; ohne Timeout ist der Aufruf "fire-and-forget" und alle Pong-Antworten werden asynchron über die Standard-Verbindungsereignisse zugestellt. Ausnahmen, die beim Schreiben ausgelöst werden, werden an OnException weitergeleitet.

Beispiel


oServer.Ping('keepalive');

Zurück zu Methoden