TsgcWebSocketClient › Events › OnBeforeHeartBeat

OnBeforeHeartBeat イベント

各HeartBeatピングの前に発生し、アプリケーションがカスタムキープアライブメッセージを送信できます。

構文

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

デフォルト値

—

解説

HeartBeat が有効な場合、クライアントは HeartBeat.Interval 秒ごとに標準の WebSocket ping を送信します。OnBeforeHeartBeat は、その ping が書き込まれる直前に発生し、アプリケーションが提供された接続を使用して独自のキープアライブペイロードを送信できます。Handled を True に設定するとデフォルトの ping が抑制されます。False（デフォルト）のままにするとハンドラーが返った後に標準の ping が送信されます。

使用例

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

イベントに戻る