TsgcWebSocketProxyServer › Événements › OnBeforeHeartBeat

OnBeforeHeartBeat Événement

Se déclenche avant chaque ping HeartBeat afin que l'application puisse implémenter un maintien de connexion personnalisé pour un client WebSocket en aval.

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 proxy envoie un ping WebSocket standard à chaque client en aval connecté toutes les HeartBeat.Interval secondes. OnBeforeHeartBeat est déclenché immédiatement avant que ce ping soit écrit pour chaque connexion afin que l'application puisse émettre sa propre charge utile de keep-alive sur la Connection fournie. Définir Handled à True supprime le ping par défaut pour ce cycle ; le laisser à False (la valeur par défaut) laisse le ping standard être envoyé après le retour du gestionnaire. Utilisez-le pour implémenter des battements de cœur spécifiques au protocole ou pour faire varier la charge utile par connexion ; seule la liaison WebSocket est pinguée ici, le lien TCP en amont n'est pas touché par cet événement.

Exemple


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

Retour aux événements