TsgcWebSocketProxyServer › Eventos › OnBeforeHeartBeat

OnBeforeHeartBeat Event

Disparado antes de cada ping de HeartBeat para que a aplicação possa implementar um keep-alive personalizado para um cliente WebSocket downstream.

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 servidor proxy envia um ping WebSocket padrão a cada cliente downstream conectado a cada HeartBeat.Interval segundos. OnBeforeHeartBeat é gerado imediatamente antes desse ping ser escrito para cada conexão, para que a aplicação possa emitir sua própria carga útil de keep-alive na Connection fornecida. Definir Handled como True suprime o ping padrão para este ciclo; deixá-lo False (o padrão) permite que o ping padrão seja enviado após o manipulador retornar. Utilize-o para implementar heartbeats específicos de protocolo ou para variar a carga útil por conexão; somente o leg WebSocket recebe ping aqui, o link TCP upstream não é tocado por este evento.

Exemplo

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

Voltar para Eventos