TsgcWebSocketClient › イベント › OnMessage

OnMessage イベント

サーバーがクライアントにテキストメッセージを送信するたびに発生します。

構文

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

デフォルト値

—

解説

OnMessage は、サーバーから完全なテキストフレームが受信されると発生します。Text パラメータはデコードされた UTF-8 文字列を運び、Connection パラメータはメッセージが届いたセッションを識別します。デフォルトでは NotifyEvents は neAsynchronous であるため、ハンドラーはメインスレッドのコンテキストで実行され、UI コントロールを直接安全に更新できます。クライアントが大量のメッセージを受信する場合や同期を自己管理する場合は neNoSync に切り替えてください。Options.FragmentedMessages が frgOnlyFragmented の場合、このイベントは発生せず、ペイロードは OnFragmented を通じて配信されます。

使用例

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

イベントに戻る