TsgcWebSocketClient › Eventos › OnBeforeHeartBeat

OnBeforeHeartBeat Event

Disparado antes de cada ping de HeartBeat para que a aplicação possa enviar uma mensagem de keep-alive personalizada.

Sintaxe

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

Valor Padrão

—

Observações

Quando o HeartBeat está habilitado, o cliente envia um ping WebSocket padrão a cada HeartBeat.Interval segundos. OnBeforeHeartBeat é gerado imediatamente antes de esse ping ser gravado, para que a aplicação possa emitir seu próprio payload keep-alive utilizando a Connection fornecida. Definir Handled como True suprime o ping padrão; deixá-lo como False (o padrão) permite que o ping padrão seja enviado após o manipulador retornar.

Exemplo

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

Voltar para Eventos