TsgcWebSocketHTTPServer › 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

O OnMessage é gerado assim que um quadro de texto completo é recebido de um cliente WebSocket. O parâmetro Text carrega a string UTF-8 decodificada e o parâmetro Connection identifica a sessão remetente, de modo que o handler pode 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 vazão, defina NotifyEvents como neNoSync para despachar na thread da conexão e implemente sua própria sincronização. Se Options.FragmentedMessages for frgOnlyFragmented, o evento não é gerado e o payload é entregue por meio de OnFragmented.

Exemplo

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

Voltar para Eventos