TsgcWebSocketClientEvents › OnBeforeHeartBeat

OnBeforeHeartBeat Zdarzenie

Wywoływane przed każdym pingiem HeartBeat, dzięki czemu aplikacja może wysłać niestandardową wiadomość podtrzymującą połączenie.

Składnia

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

Wartość domyślna

Uwagi

Gdy HeartBeat jest włączony, klient wysyła standardowy ping WebSocket co HeartBeat.Interval sekund. Zdarzenie OnBeforeHeartBeat jest wywoływane bezpośrednio przed zapisaniem tego pinga, umożliwiając aplikacji emisję własnego ładunku keep-alive za pomocą dostarczonego obiektu Connection. Ustawienie Handled na True pomija domyślny ping; pozostawienie wartości False (domyślnie) pozwala na wysłanie standardowego pinga po powrocie z procedury obsługi.

Przykład


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

Powrót do Zdarzeń