TsgcWebSocketClient › Events › OnBeforeHeartBeat

OnBeforeHeartBeat 事件

在每次心跳 ping 之前触发，以便应用程序发送自定义保活消息。

语法

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

默认值

—

备注

当 HeartBeat 启用时，客户端每隔 HeartBeat.Interval 秒发送一次标准 WebSocket ping。OnBeforeHeartBeat 在 ping 写入之前立即触发，以便应用程序使用提供的 Connection 发送自定义的保活载荷。将 Handled 设为 True 可禁止默认的 ping；保留 False（默认）则在处理程序返回后发送标准 ping。

示例

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

返回事件