TsgcWebSocketClient › Événements › OnBeforeHeartBeat

OnBeforeHeartBeat Événement

Se déclenche avant chaque ping HeartBeat afin que l'application puisse envoyer un message de maintien de connexion 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 client envoie un ping WebSocket standard toutes les HeartBeat.Interval secondes. OnBeforeHeartBeat est déclenché immédiatement avant l'écriture de ce ping, afin que l'application puisse émettre sa propre charge utile de maintien de connexion via la connexion fournie. Définir Handled à True supprime le ping par défaut ; le laisser à False (valeur par défaut) permet l'envoi du ping standard après le retour du gestionnaire.

Exemple

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

Retour aux événements