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 のカンマ区切りリスト。空の場合は無視されます。

解説

このオーバーロードは、指定されたフィルターに一致するすべてのアクティブな接続にテキストフレームを送信します。フィルターはANDセマンティクスで結合されます。接続は、空でないすべてのフィルターを満たす場合にのみメッセージを受信し、そのGUIDがExcludeに表示される場合は決して到達されません。LoadBalancerが有効な場合、呼び出しはクラスタ全体に転送されるため、リモートノードもローカルクライアントにメッセージを配信します。呼び出しは呼び出し元のスレッドで実行され、フレームが各ソケットに渡されると戻ります。接続ごとの書き込みエラーは、ブロードキャストを中止することなく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` で、完全なスタンドアロンメッセージを送信します。

解説

このオーバーロードはストリームの内容をバイナリフレームとして、チャネル、プロトコル、Include および Exclude フィルターを通過するすべての接続にブロードキャストします。ストリームは現在の位置から読み取られます。サーバーは所有権を取得しないため、呼び出し元は Broadcast が返るまでストリームを保持する必要があります。LoadBalancer が有効な場合、バイナリペイロードは他のノードに転送され、ローカルクライアントへの再配信が可能になります。aSize と aStreaming を組み合わせて、大きなペイロードを 1 つの過大なフレームではなく複数の WebSocket フラグメントとしてストリーミングしてください。

使用例


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

メソッドに戻る