TsgcWebSocketServer › Événements › OnBeforeHeartBeat

OnBeforeHeartBeat Événement

Se déclenche avant chaque ping HeartBeat afin que l'application puisse implémenter un keep-alive personnalisé.

Syntaxe

property OnBeforeHeartBeat: TsgcWSOnBeforeHeartBeatEvent;
// TsgcWSOnBeforeHeartBeatEvent = procedure(Sender: TObject; const Connection: TsgcWSConnection; var Handled: Boolean) of object

Valeur par défaut

—

Remarques

Lorsque HeartBeat est activé, le serveur envoie un ping WebSocket standard à chaque client connecté toutes les secondes HeartBeat.Interval. OnBeforeHeartBeat est déclenché immédiatement avant que ce ping ne soit écrit pour chaque connexion, de sorte que l'application peut émettre sa propre charge utile de maintien en vie sur la Connexion fournie. Définir Handled à True supprime le ping par défaut pour ce cycle ; le laisser à False (par défaut) laisse le ping standard être envoyé après le retour du gestionnaire. Utilisez-le pour implémenter des heartbeats spécifiques au protocole ou pour varier la charge utile par connexion.

Exemple

procedure OnBeforeHeartBeat(Sender: TObject; const Connection: TsgcWSConnection;
  var Handled: Boolean);
begin
  Connection.WriteData('ping');
  Handled := True;
end;

Retour aux événements