TsgcWebSocketHTTPServer › メソッド › WriteData

WriteData メソッド

接続 GUID で識別された単一クライアントに WebSocket メッセージを送信します。

オーバーロード

オーバーロード 1

構文

function WriteData(const aGuid, aMessage: string): Boolean;

パラメータ

名前	タイプ	説明
`aGuid`	`const string`	クライアントのハンドシェイクが完了したときにサーバーによって割り当てられたターゲット接続の識別子。
`aMessage`	`const string`	そのクライアントに WebSocket テキストフレームとして配信するテキストペイロード。

戻り値

指定された GUID を持つ接続が見つかりフレームがそのソケットに渡された場合は True、一致するアクティブな接続が存在しない場合は False。(Boolean)

解説

このオーバーロードは GUID が aGuid と一致する WebSocket 接続を検索し、その単一のクライアントにテキストメッセージを送信します。GUID は TsgcWSConnection.Guid が公開する値で、通常 OnConnect でキャプチャされアプリケーションが保存します。アップグレードされた WebSocket セッションのみが対象です。純粋な HTTP リクエストに属する GUID は拒否され False が返されます。QueueOptions.Text が qmNone 以外の値に設定されている場合、フレームはキューに入れられ呼び出し元のスレッドではなく接続スレッドからディスパッチされます (IOHandlerOptions.IOHandlerType = iohIOCP の場合はサポートされません)。すべてのアクティブなクライアントに1回の呼び出しで到達するには Broadcast を使用してください。

使用例


oServer.WriteData('guid', 'My First sgcWebSockets Message!.');

オーバーロード 2

構文

function WriteData(const aGuid: String; aStream: TStream; aSize: Integer = 0; const aStreaming: TwsStreaming = stmNone) : Boolean;

パラメータ

名前	タイプ	説明
`aGuid`	`const String`	クライアントのハンドシェイクが完了したときにサーバーによって割り当てられたターゲット接続の識別子。
`aStream`	`TStream`	クライアントへの WebSocket バイナリフレームとして送信されるコンテンツを含むソースストリーム。呼び出し元がストリームの所有者のままです。
`aSize`	`Integer`	オプションのフラグメントサイズ (バイト単位)。ゼロより大きい場合、ストリームはこのサイズの複数のフラグメントに分割されます。ストリーム全体を単一のフレームとして送信するにはデフォルトの 0 を使用してください。
`aStreaming`	`const TwsStreaming`	フラグメント化された送信のストリーミングモード（`stmNone`、`stmStart`、`stmContinue`、`stmFinish`）。デフォルトは `stmNone` で、完全なスタンドアロンメッセージを送信します。

戻り値

指定された GUID を持つ接続が見つかり、ストリームがそのソケットに渡された場合は True。一致するアクティブな接続が存在しない場合は False。（Boolean）

解説

このオーバーロードは、提供されたストリームから読み取ったバイナリペイロードで単一のWebSocketクライアントをターゲットにします。ストリームは現在の位置から消費されます。サーバーは所有権を取得しないため、呼び出し元はWriteDataが返るまで（またはキューに入れる場合は送信が完了するまで）ストリームをアライブに保つ必要があります。QueueOptions.BinaryがqmNone以外の値に設定されている場合、フレームはキューに入れられ、呼び出し元のスレッドではなく接続スレッドからディスパッチされます（IOHandlerOptions.IOHandlerType = iohIOCPの場合はサポートされません）。非常に大きなペイロードを複数のWebSocketフレームに分割して送信する場合はaSizeとaStreamingを一緒に使用してください。

使用例


oStream := TMemoryStream.Create;
try
  oStream.LoadFromFile('payload.bin');
  oServer.WriteData('guid', oStream);
finally
  oStream.Free;
end;

メソッドに戻る