TsgcWebSocketServer_HTTPAPI › イベント › 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;

イベントに戻る