TsgcWebSocketServer_HTTPAPI › メソッド › Broadcast

Broadcast メソッド

オプションでチャンネル、プロトコル、または接続 GUID リストでフィルタリングしながら、接続されているすべてのクライアントに同じメッセージを送信します。

オーバーロード

オーバーロード 1

構文

procedure Broadcast(const aMessage: string; const aChannel: string = ''; const aProtocol: string = ''; const Exclude: String = ''; const Include: String = '');

パラメータ

名前	タイプ	説明
`aMessage`	`const string`	一致する各クライアントにWebSocketテキストフレームとして配信されるテキストペイロード。
`aChannel`	`const string`	空でない場合、メッセージは指定されたチャンネルをサブスクライブしているクライアントのみに送信されます。
`aProtocol`	`const string`	空でない場合、メッセージは指定されたWebSocketサブプロトコルを使用するクライアントにのみ送信されます。
`Exclude`	`const String`	このブロードキャストでスキップする必要がある接続 GUID のカンマ区切りリスト。
`Include`	`const String`	ブロードキャストをそのサブセットに制限する接続 GUID のカンマ区切りリスト。空の場合は無視されます。

解説

このオーバーロードは、指定されたフィルターに一致するすべてのアクティブな WebSocket 接続にテキストフレームを送信します。フィルターは AND セマンティクスで組み合わされます。接続は、すべての空でないフィルターを満たす場合のみメッセージを受け取り、その GUID が Exclude に含まれている場合は受け取りません。Asynchronous が有効な場合、各 HTTP.sys 書き込みが完了する前に呼び出しが返され、OnAsynchronous イベントが完了を報告します。無効の場合、呼び出しは呼び出し元のスレッドで実行され、フレームが各ソケットにキューイングされると返されます。接続ごとの書き込みエラーは、ブロードキャストを中断せずに OnException を通じて報告されます。

使用例


oServer.Broadcast('Hello From Server');

オーバーロード 2

構文

procedure Broadcast(aStream: TStream; const aChannel: string = ''; const aProtocol: string = ''; const Exclude: String = ''; const Include: String = ''; const aSize: Integer = 0; const aStreaming: TwsStreaming = stmNone);

パラメータ

名前	タイプ	説明
`aStream`	`TStream`	各一致するクライアントに WebSocket バイナリフレームとして配信されるコンテンツのソースストリーム。呼び出し元がストリームの所有者のままです。
`aChannel`	`const string`	空でない場合、メッセージは指定されたチャンネルをサブスクライブしているクライアントのみに送信されます。
`aProtocol`	`const string`	空でない場合、メッセージは指定されたWebSocketサブプロトコルを使用するクライアントにのみ送信されます。
`Exclude`	`const String`	このブロードキャストでスキップする必要がある接続 GUID のカンマ区切りリスト。
`Include`	`const String`	ブロードキャストをそのサブセットに制限する接続 GUID のカンマ区切りリスト。空の場合は無視されます。
`aSize`	`const Integer`	オプションのフラグメントサイズ（バイト単位）。ゼロより大きい場合、各クライアントはこのサイズのフラグメントに分割されたストリームを受け取ります。0（デフォルト）を使用するとストリーム全体を単一フレームとして送信します。
`aStreaming`	`const TwsStreaming`	フラグメント化された送信のストリーミングモード（`stmNone`、`stmStart`、`stmContinue`、`stmFinish`）。デフォルトは `stmNone` で、完全なスタンドアロンメッセージを送信します。

解説

このオーバーロードは、ストリームの内容を、channel、protocol、Include、Excludeフィルターを通過するすべての接続にバイナリフレームとしてブロードキャストします。ストリームは現在の位置から読み取られます。サーバーは所有権を取得しないため、呼び出し元はBroadcastが返るまで(またはAsynchronousが有効な場合はOnAsynchronousイベントが完了を報告するまで)ストリームを生きたままにしておく必要があります。非常に大きなペイロードを1つの巨大なフレームではなく複数のWebSocketフラグメントとしてストリーミングするには、aSizeをaStreamingとともに使用します。これは、カーネルが送信データをバッファするHTTP.sysで特に役立ちます。

使用例


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

メソッドに戻る