TsgcWebSocketHTTPServer › Méthodes › Broadcast

Broadcast Méthode

Envoie le même message WebSocket à tous les clients connectés, filtrés optionnellement par canal, protocole ou liste de GUIDs de connexion.

Surcharges

Surcharge 1

Syntaxe

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

Paramètres

Nom	Type	Description
`aMessage`	`const string`	Charge utile texte livrée à chaque client correspondant sous forme de trame texte WebSocket.
`aChannel`	`const string`	Lorsqu'il est non vide, le message est envoyé uniquement aux clients abonnés au canal donné.
`aProtocol`	`const string`	Lorsque non vide, le message est envoyé uniquement aux clients utilisant le sous-protocole WebSocket spécifié.
`Exclude`	`const String`	Liste séparée par des virgules des GUID de connexion qui doivent être ignorés par cette diffusion.
`Include`	`const String`	Liste de GUID de connexions séparés par des virgules limitant la diffusion à ce sous-ensemble ; ignorée si vide.

Remarques

Cette surcharge envoie une trame texte à chaque connexion WebSocket active hébergée par le serveur HTTP qui correspond aux filtres fournis. Les filtres sont combinés avec une sémantique AND : une connexion reçoit le message uniquement lorsqu'elle satisfait chaque filtre non vide, et n'est jamais atteinte lorsque son GUID apparaît dans Exclude. Les requêtes HTTP/HTTP2 pures sont ignorées car Broadcast ne cible que les clients ayant effectué la négociation WebSocket. Lorsque LoadBalancer est activé, l'appel est transmis à l'ensemble du cluster afin que les nœuds distants délivrent également le message à leurs clients locaux. L'appel s'exécute sur le thread appelant et retourne une fois les trames remises à chaque socket ; les erreurs d'écriture par connexion sont signalées via OnException sans interrompre la diffusion.

Exemple


oServer.Broadcast('Hello From Server');

Surcharge 2

Syntaxe

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

Paramètres

Nom	Type	Description
`aStream`	`TStream`	Flux source dont le contenu est délivré à chaque client correspondant sous forme de trame binaire WebSocket. L'appelant reste propriétaire du flux.
`aChannel`	`const string`	Lorsqu'il est non vide, le message est envoyé uniquement aux clients abonnés au canal donné.
`aProtocol`	`const string`	Lorsque non vide, le message est envoyé uniquement aux clients utilisant le sous-protocole WebSocket spécifié.
`Exclude`	`const String`	Liste séparée par des virgules des GUID de connexion qui doivent être ignorés par cette diffusion.
`Include`	`const String`	Liste de GUID de connexions séparés par des virgules limitant la diffusion à ce sous-ensemble ; ignorée si vide.
`aSize`	`const Integer`	Taille de fragment optionnelle en octets ; lorsqu'elle est supérieure à zéro, chaque client reçoit le flux découpé en fragments de cette taille. Utilisez 0 (valeur par défaut) pour envoyer le flux entier en une seule trame.
`aStreaming`	`const TwsStreaming`	Mode de streaming pour la transmission fragmentée (`stmNone`, `stmStart`, `stmContinue`, `stmFinish`). La valeur par défaut est `stmNone`, qui envoie un message autonome complet.

Remarques

Cette surcharge diffuse le contenu du flux sous forme de trame binaire à chaque connexion WebSocket hébergée par le serveur HTTP qui passe les filtres de canal, protocole, Include et Exclude. Le flux est lu depuis sa position actuelle ; le serveur n'en prend pas possession, de sorte que l'appelant doit maintenir le flux actif jusqu'au retour de Broadcast. Lorsque LoadBalancer est activé, la charge utile binaire est transmise aux autres nœuds afin qu'ils puissent la redistribuer à leurs clients locaux. Utilisez aSize conjointement avec aStreaming pour diffuser de très grandes charges utiles sous forme de multiples fragments WebSocket plutôt qu'une seule trame surdimensionnée.

Exemple


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

Retour aux méthodes