TsgcWebSocketServer_HTTPAPI › Methods › Broadcast
Envoie le même message à tous les clients connectés, éventuellement filtré par canal, protocole ou liste de GUID de connexion.
procedure Broadcast(const aMessage: string; const aChannel: string = ''; const aProtocol: string = ''; const Exclude: String = ''; const Include: String = '');| 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. |
Cette surcharge envoie une trame de texte à chaque connexion WebSocket active 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. Lorsque Asynchronous est activé, l'appel retourne avant que chaque écriture http.sys ne soit terminée et l'événement OnAsynchronous signale la complétion ; lorsqu'il est désactivé, l'appel s'exécute sur le thread de l'appelant et retourne une fois les trames mises en file d'attente pour chaque socket. Les erreurs d'écriture par connexion sont signalées via OnException sans interrompre la diffusion.
oServer.Broadcast('Hello From Server');procedure Broadcast(aStream: TStream; const aChannel: string = ''; const aProtocol: string = ''; const Exclude: String = ''; const Include: String = ''; const aSize: Integer = 0; const aStreaming: TwsStreaming = stmNone);| 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. |
Cette surcharge diffuse le contenu du flux sous forme de trame binaire à chaque connexion qui passe les filtres de canal, protocole, Include et Exclude. Le flux est lu depuis sa position actuelle ; le serveur ne prend pas possession du flux, donc l'appelant doit le maintenir actif jusqu'au retour de Broadcast (ou, lorsque Asynchronous est activé, jusqu'à ce que l'événement OnAsynchronous signale la complétion). Utilisez aSize avec aStreaming pour diffuser de très grandes charges utiles sous forme de multiples fragments WebSocket plutôt qu'une trame surdimensionnée, ce qui est particulièrement utile sur HTTP.sys où le noyau met en mémoire tampon les données sortantes.
oStream := TMemoryStream.Create;
try
oStream.LoadFromFile('payload.bin');
oServer.Broadcast(oStream);
finally
oStream.Free;
end;