WriteData メソッド

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

オーバーロード

オーバーロード 1

構文

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

パラメータ

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

戻り値

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

解説

このオーバーロードは、aGuid に一致する接続を検索し、その単一のクライアントにテキストメッセージを送信します。GUID は TsgcWSConnection.Guid によって公開される値で、通常は OnConnect でキャプチャされてアプリケーションに保存されます。QueueOptions.Text が qmNone 以外の値に設定されている場合、フレームはキューに入れられ、呼び出し元のスレッドではなく接続スレッドから配信されます（IOHandlerOptions.IOHandlerType = iohIOCP の場合はサポートされません）。すべてのアクティブなクライアントに一度に到達するには 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）

解説

このオーバーロードは、提供されたストリームから読み込まれたバイナリペイロードを持つ単一のクライアントを対象とします。ストリームは現在の位置から消費され、サーバーは所有権を取得しないため、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;

メソッドに戻る