TsgcWebSocketClient › Propriedades › HeartBeat

HeartBeat Propriedade

Envia frames de ping WebSocket periódicos para manter a conexão ativa.

Sintaxe

property HeartBeat: TsgcWSHeartBeat_Options read GetHeartBeat write SetHeartBeat;

Valor Padrão

Enabled=False

Observações

Quando HeartBeat.Enabled é True, o cliente envia um ping a cada Interval segundos. As subpropriedades incluem Timeout (máximo de segundos entre ping e pong antes de a conexão ser fechada, 0 para desabilitar) e HeartBeatType: hbtAlways envia um ping em cada intervalo, enquanto hbtOnlyIfNoMsgRcvInterval só faz ping quando nenhuma mensagem foi recebida durante o último intervalo. O evento OnBeforeHeartBeat permite que você substitua o ping padrão por uma mensagem personalizada.

Exemplo

oClient := TsgcWebSocketClient.Create(nil);
oClient.HeartBeat.Interval := 30;
oClient.HeartBeat.Timeout := 0;
oClient.HeartBeat.Enabled := true;
oClient.Active := true;

Voltar para Propriedades