TsgcWebSocketServer_HTTPAPI › Eventos › OnMessage

OnMessage Evento

Se activa cada vez que un cliente envía un mensaje de texto y es recibido por el servidor.

Sintaxis

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

Valor Predeterminado

—

Observaciones

OnMessage se dispara cuando se recibe un marco de texto completo de un cliente a través del pipeline WebSocket de HTTP.SYS. El parámetro Text contiene la cadena UTF-8 decodificada y el parámetro Connection identifica la sesión del remitente, de modo que el manejador puede responder en la misma conexión o retransmitir el mensaje a otros clientes. El evento se ejecuta en el contexto del hilo de trabajo IOCP; si necesita actualizar controles de la interfaz de usuario, pase la llamada al hilo principal. Si Options.FragmentedMessages es frgOnlyFragmented, el evento no se dispara y la carga útil se entrega mediante OnFragmented.

Ejemplo

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

Volver a Eventos