TsgcWebSocketServer › Methoden › Broadcast

Broadcast Methode

Verstuurt hetzelfde bericht naar alle verbonden clients, optioneel gefilterd op kanaal, protocol of verbindings-GUID-lijst.

Overloads

Overload 1

Syntaxis

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

Parameters

Naam	Type	Beschrijving
`aMessage`	`const string`	Tekstpayload geleverd aan elke overeenkomende client als een WebSocket-tekstframe.
`aChannel`	`const string`	Wanneer niet-leeg, wordt het bericht alleen verzonden naar clients die op het opgegeven channel zijn geabonneerd.
`aProtocol`	`const string`	Wanneer niet leeg, wordt het bericht alleen verzonden naar clients die het opgegeven WebSocket-subprotocol gebruiken.
`Exclude`	`const String`	Door komma's gescheiden lijst van verbindings-GUID's die door deze broadcast moeten worden overgeslagen.
`Include`	`const String`	Door komma's gescheiden lijst van verbindings-GUID's die de broadcast beperken tot die subset; genegeerd wanneer leeg.

Opmerkingen

Deze overload verzendt een tekstframe naar alle actieve verbindingen die overeenkomen met de opgegeven filters. Filters worden gecombineerd met AND-semantiek: een verbinding ontvangt het bericht alleen als aan elk niet-leeg filter wordt voldaan en wordt nooit bereikt als de GUID ervan voorkomt in Exclude. Wanneer LoadBalancer is ingeschakeld, wordt de aanroep doorgestuurd naar het cluster zodat externe knooppunten het bericht ook aan hun lokale clients leveren. De aanroep loopt op de thread van de aanroeper en keert terug zodra de frames aan elke socket zijn overhandigd; schrijffouten per verbinding worden gerapporteerd via OnException zonder de broadcast te onderbreken.

Voorbeeld


oServer.Broadcast('Hello From Server');

Overload 2

Syntaxis

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

Parameters

Naam	Type	Beschrijving
`aStream`	`TStream`	Bronstream waarvan de inhoud aan elke overeenkomende client wordt afgeleverd als een binair WebSocket-frame. De aanroeper blijft eigenaar van de stream.
`aChannel`	`const string`	Wanneer niet-leeg, wordt het bericht alleen verzonden naar clients die op het opgegeven channel zijn geabonneerd.
`aProtocol`	`const string`	Wanneer niet leeg, wordt het bericht alleen verzonden naar clients die het opgegeven WebSocket-subprotocol gebruiken.
`Exclude`	`const String`	Door komma's gescheiden lijst van verbindings-GUID's die door deze broadcast moeten worden overgeslagen.
`Include`	`const String`	Door komma's gescheiden lijst van verbindings-GUID's die de broadcast beperken tot die subset; genegeerd wanneer leeg.
`aSize`	`const Integer`	Optionele fragmentgrootte in bytes; wanneer groter dan nul ontvangt elke client de stream opgesplitst in fragmenten van deze grootte. Gebruik 0 (de standaard) om de volledige stream als één frame te verzenden.
`aStreaming`	`const TwsStreaming`	Streamingmodus voor gefragmenteerde overdracht (`stmNone`, `stmStart`, `stmContinue`, `stmFinish`). Standaard `stmNone`, waarmee een volledig zelfstandig bericht wordt verzonden.

Opmerkingen

Deze overload verzendt de streaminhoud als een binair frame naar elke verbinding die de kanaal-, protocol-, Include- en Exclude-filters doorstaat. De stream wordt gelezen vanaf de huidige positie; de server neemt geen eigendom, dus de aanroeper moet de stream in leven houden totdat Broadcast terugkeert. Wanneer LoadBalancer is ingeschakeld, wordt de binaire payload doorgestuurd naar andere knooppunten zodat zij deze opnieuw kunnen bezorgen bij hun lokale clients. Gebruik aSize samen met aStreaming om zeer grote payloads te streamen als meerdere WebSocket-fragmenten in plaats van één oversized frame.

Voorbeeld


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

Terug naar methoden