TsgcWSPServer_sgcMethoden › Broadcast

Broadcast Methode

Zendt een tekst- of stream-payload uit naar alle verbonden clients, optioneel gefilterd op kanaal.

Overloads

Overload 1

Syntaxis

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

Parameters

NaamTypeBeschrijving
aMessagestringTekstpayload verpakt in de sgc-envelop en bezorgd aan ontvangers via OnMessage.
aChannelstringOptioneel kanaalfilter. Indien opgegeven, ontvangen alleen clients die geabonneerd zijn op dat kanaal de payload; laat leeg om elke verbinding te bereiken.
ExcludeStringPuntkomma-gescheiden lijst van verbindings-GUID's die de broadcast niet mogen ontvangen.
IncludeStringPuntkomma-gescheiden lijst van verbindings-GUID's waartoe de broadcast is beperkt, waarbij het kanaalfilter wordt overschreven.

Opmerkingen

Tekst overload. Sends a method=message envelope to the selected recipients. When QoS is Level 1 or Level 2 de server stores het bericht in the in behandeling list and waits for per-verbinding acknowledgements, resending if necessary; with QoS Level 0 het bericht is transmitted once without tracking.

Voorbeeld

oProtocol.Broadcast('hello everyone');
oProtocol.Broadcast('channel update', 'news');

Overload 2

Syntaxis

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

Parameters

NaamTypeBeschrijving
aStreamTStreamBinaire payload die ongewijzigd wordt verstuurd via de WebSocket; ontvangers ontvangen het via OnBinary.
aChannelstringOptioneel kanaalfilter. Indien opgegeven ontvangen alleen clients die op dat kanaal zijn geabonneerd het frame.
ExcludeStringDoor puntkomma's gescheiden lijst van verbindings-GUID's die het frame niet mogen ontvangen.
IncludeStringPuntkomma-gescheiden lijst van verbindingsGuid's waartoe het frame is beperkt.
aSizeIntegerChunkgrootte in bytes wanneer de payload wordt gefragmenteerd; geef 0 door om de stream als één enkel frame te verzenden.
aStreamingTwsStreamingStreamingstrategie (stmNone, stmFragmented, stmCustom) die wordt gebruikt om de stream in frames op te delen.

Opmerkingen

Binaire overload. Verzendt de stream rechtstreeks naar geselecteerde ontvangers zonder deze te verpakken in de sgc JSON-envelope, zodat clients een onbewerkt binair frame zien. In tegenstelling tot de tekstoverload gebruikt dit pad niet de QoS-wachtlijst; bezorging is best-effort op de onderliggende WebSocket-transport.

Voorbeeld

oStream := TFileStream.Create('image.png', fmOpenRead);
try
  oProtocol.Broadcast(oStream, 'news');
finally
  oStream.Free;
end;

Terug naar methoden