TsgcWebSocketServer_HTTPAPI › Events › OnMessage

OnMessage 事件

每次客户端发送文本消息且服务器接收到时触发。

语法

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

默认值

—

备注

OnMessage 在通过 HTTP.SYS WebSocket 管道从客户端接收到完整文本帧后触发。Text 参数携带解码后的 UTF-8 字符串，Connection 参数标识发送方会话，处理程序可以在同一连接上回复或将消息中继给其他客户端。事件在 IOCP 工作线程的上下文中运行；如果需要更新 UI 控件，请将调用编组到主线程。如果 Options.FragmentedMessages 为 frgOnlyFragmented，则不触发此事件，有效载荷通过 OnFragmented 传递。

示例

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

返回事件