TsgcWebSocketServer › Eventos › OnMessage

OnMessage Event

Dispara toda vez que um cliente envia uma mensagem de texto e ela é recebida pelo servidor.

Sintaxe

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

Valor Padrão

—

Observações

OnMessage é gerado quando um text frame completo foi recebido de um cliente. O parâmetro Text carrega a string UTF-8 decodificada e o parâmetro Connection identifica a sessão remetente, para que o handler possa responder na mesma conexão ou retransmitir a mensagem para outros clientes. Por padrão, NotifyEvents é neAsynchronous e o handler é executado sincronizado com a thread principal, o que torna seguro atualizar controles de UI; para servidores de alta taxa de transferência, defina NotifyEvents como neNoSync para despachar na thread de conexão e implemente sua própria sincronização. Se Options.FragmentedMessages for frgOnlyFragmented, o evento não é gerado e o payload é entregue através de OnFragmented.

Exemplo

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

Voltar para Eventos