TsgcWebSocketClient › Eventos › OnBeforeHeartBeat

OnBeforeHeartBeat Evento

Se activa antes de cada ping HeartBeat para que la aplicación pueda enviar un mensaje de mantenimiento de conexión personalizado.

Sintaxis

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

Valor Predeterminado

—

Observaciones

Cuando HeartBeat está habilitado, el cliente envía un ping WebSocket estándar cada HeartBeat.Interval segundos. OnBeforeHeartBeat se activa inmediatamente antes de que se escriba ese ping, de modo que la aplicación pueda emitir su propia carga útil de keep-alive usando la Connection proporcionada. Establecer Handled en True suprime el ping predeterminado; dejarlo en False (el valor predeterminado) permite que el ping estándar se envíe tras retornar el controlador.

Ejemplo

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

Volver a Eventos