TsgcWebSocketServer_HTTPAPI › Methods › Broadcast

Broadcast Methode

Sendet dieselbe Nachricht an alle verbundenen Clients, optional gefiltert nach Kanal, Protokoll oder Verbindungs-GUID-Liste.

Überladungen

Overload 1

Syntax

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

Parameter

Name	Typ	Beschreibung
`aMessage`	`const string`	Text-Payload, die jedem übereinstimmenden Client als WebSocket-Text-Frame zugestellt wird.
`aChannel`	`const string`	Wenn nicht leer, wird die Nachricht nur an Clients gesendet, die den angegebenen Kanal abonniert haben.
`aProtocol`	`const string`	Wenn nicht leer, wird die Nachricht nur an Clients gesendet, die das angegebene WebSocket-Subprotokoll verwenden.
`Exclude`	`const String`	Kommagetrennte Liste von Verbindungs-GUIDs, die von diesem Broadcast übersprungen werden müssen.
`Include`	`const String`	Durch Kommas getrennte Liste von Verbindungs-GUIDs, die den Broadcast auf diese Teilmenge beschränkt; wird ignoriert, wenn leer.

Hinweise

Diese Überladung sendet einen Text-Frame an jede aktive WebSocket-Verbindung, die den angegebenen Filtern entspricht. Filter werden mit UND-Semantik kombiniert: Eine Verbindung empfängt die Nachricht nur, wenn sie jeden nicht leeren Filter erfüllt, und wird nie erreicht, wenn ihre GUID in Exclude erscheint. Wenn Asynchronous aktiviert ist, kehrt der Aufruf zurück, bevor jeder HTTP.sys-Schreibvorgang abgeschlossen ist, und das Ereignis OnAsynchronous meldet den Abschluss; wenn deaktiviert, läuft der Aufruf im Thread des Aufrufers und kehrt zurück, sobald die Frames für jeden Socket in die Warteschlange eingereiht sind. Schreibfehler pro Verbindung werden über OnException gemeldet, ohne den Broadcast abzubrechen.

Beispiel


oServer.Broadcast('Hello From Server');

Überladung 2

Syntax

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

Parameter

Name	Typ	Beschreibung
`aStream`	`TStream`	Quell-Stream, dessen Inhalt jedem passenden Client als WebSocket-Binär-Frame zugestellt wird. Der Aufrufer bleibt Eigentümer des Streams.
`aChannel`	`const string`	Wenn nicht leer, wird die Nachricht nur an Clients gesendet, die den angegebenen Kanal abonniert haben.
`aProtocol`	`const string`	Wenn nicht leer, wird die Nachricht nur an Clients gesendet, die das angegebene WebSocket-Subprotokoll verwenden.
`Exclude`	`const String`	Kommagetrennte Liste von Verbindungs-GUIDs, die von diesem Broadcast übersprungen werden müssen.
`Include`	`const String`	Durch Kommas getrennte Liste von Verbindungs-GUIDs, die den Broadcast auf diese Teilmenge beschränkt; wird ignoriert, wenn leer.
`aSize`	`const Integer`	Optionale Fragmentgröße in Bytes; bei einem Wert größer als null erhält jeder Client den Stream in Fragmente dieser Größe aufgeteilt. Verwenden Sie 0 (Standard), um den gesamten Stream als einzelnen Frame zu senden.
`aStreaming`	`const TwsStreaming`	Streaming-Modus für die fragmentierte Übertragung (`stmNone`, `stmStart`, `stmContinue`, `stmFinish`). Standard ist `stmNone`, was eine vollständige eigenständige Nachricht sendet.

Hinweise

Diese Überladung sendet den Stream-Inhalt als Binär-Frame an jede Verbindung, die die Kanal-, Protokoll-, Include- und Exclude-Filter passiert. Der Stream wird ab seiner aktuellen Position gelesen; der Server übernimmt keinen Besitz, sodass der Aufrufer den Stream am Leben halten muss, bis Broadcast zurückkehrt (oder, wenn Asynchronous aktiviert ist, bis das Ereignis OnAsynchronous den Abschluss meldet). Verwenden Sie aSize zusammen mit aStreaming, um sehr große Nutzdaten als mehrere WebSocket-Fragmente anstatt als einen übergroßen Frame zu streamen, was besonders bei HTTP.sys nützlich ist, wo der Kernel die ausgehenden Daten puffert.

Beispiel


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

Zurück zu Methoden