TsgcWebSocketClient › Eventos › OnMessage

OnMessage Event

Dispara toda vez que o servidor envia uma mensagem de texto ao cliente.

Sintaxe

property OnMessage: TsgcWSMessageEvent;
// TsgcWSMessageEvent = procedure(Connection: TsgcWSConnection; const Text: string) of object

Valor Padrão

—

Observações

OnMessage é gerado quando um frame de texto completo é recebido do servidor. O parâmetro Text carrega a string UTF-8 decodificada; o parâmetro Connection identifica a sessão na qual a mensagem chegou. Por padrão, NotifyEvents é neAsynchronous, portanto o manipulador é executado no contexto da thread principal e é seguro atualizar controles de UI diretamente; mude para neNoSync se o cliente receber um alto volume de mensagens e você preferir tratar a sincronização por conta própria. Se Options.FragmentedMessages for frgOnlyFragmented, este evento não é gerado e o payload é entregue por meio de OnFragmented em seu lugar.

Exemplo

procedure OnMessage(Connection: TsgcWSConnection; const Text: string);
begin
  ShowMessage('Message Received from Server: ' + Text);
end;

Voltar para Eventos