TsgcWebSocketServer_HTTPAPI › 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 assim que um frame de texto completo é recebido de um cliente através do pipeline WebSocket do HTTP.SYS. O parâmetro Text carrega a string UTF-8 decodificada e o parâmetro Connection identifica a sessão remetente, então o handler pode responder na mesma conexão ou retransmitir a mensagem a outros clientes. O evento roda no contexto da thread de trabalho IOCP; se você precisar atualizar controles de UI, organize a chamada para a thread principal. 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