TsgcWebSocketServer › Metody › Broadcast
Wysyła tę samą wiadomość do wszystkich połączonych klientów, opcjonalnie filtrując według kanału, protokołu lub listy identyfikatorów GUID połączeń.
procedure Broadcast(const aMessage: string; const aChannel: string = ''; const aProtocol: string = ''; const Exclude: String = ''; const Include: String = '');| Nazwa | Typ | Opis |
|---|---|---|
aMessage | const string | Ładunek tekstowy dostarczany do każdego pasującego klienta jako ramka tekstowa WebSocket. |
aChannel | const string | Jeśli wartość jest niepusta, wiadomość jest wysyłana wyłącznie do klientów subskrybujących podany kanał. |
aProtocol | const string | Jeżeli parametr nie jest pusty, wiadomość jest wysyłana tylko do klientów korzystających z podanego subprotokołu WebSocket. |
Exclude | const String | Lista identyfikatorów GUID połączeń oddzielona przecinkami, które mają zostać pominięte przez to rozgłoszenie. |
Include | const String | Rozdzielona przecinkami lista identyfikatorów GUID połączeń ograniczająca rozgłaszanie do tego podzbioru; ignorowana, gdy jest pusta. |
To przeciążenie wysyła ramkę tekstową do każdego aktywnego połączenia spełniającego podane filtry. Filtry są łączone semantyką AND: połączenie otrzymuje wiadomość tylko wtedy, gdy spełnia wszystkie niepuste filtry i nie pojawia się w Exclude. Gdy włączony jest LoadBalancer, wywołanie jest przekazywane do całego klastra, tak aby węzły zdalne również dostarczyły wiadomość do swoich lokalnych klientów. Wywołanie działa w wątku wywołującym i zwraca sterowanie po przekazaniu ramek do każdego gniazda; błędy zapisu dla poszczególnych połączeń są zgłaszane przez OnException bez przerywania rozgłaszania.
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);| Nazwa | Typ | Opis |
|---|---|---|
aStream | TStream | Strumień źródłowy, którego zawartość jest dostarczana do każdego pasującego klienta jako binarna ramka WebSocket. Wywołujący pozostaje właścicielem strumienia. |
aChannel | const string | Jeśli wartość jest niepusta, wiadomość jest wysyłana wyłącznie do klientów subskrybujących podany kanał. |
aProtocol | const string | Jeżeli parametr nie jest pusty, wiadomość jest wysyłana tylko do klientów korzystających z podanego subprotokołu WebSocket. |
Exclude | const String | Lista identyfikatorów GUID połączeń oddzielona przecinkami, które mają zostać pominięte przez to rozgłoszenie. |
Include | const String | Rozdzielona przecinkami lista identyfikatorów GUID połączeń ograniczająca rozgłaszanie do tego podzbioru; ignorowana, gdy jest pusta. |
aSize | const Integer | Opcjonalny rozmiar fragmentu w bajtach; gdy większy od zera, każdy klient odbiera strumień podzielony na fragmenty o tym rozmiarze. Użyć 0 (domyślnie), aby wysłać cały strumień jako pojedynczą ramkę. |
aStreaming | const TwsStreaming | Tryb strumieniowania dla pofragmentowanej transmisji (stmNone, stmStart, stmContinue, stmFinish). Domyślnie stmNone, co wysyła kompletną, samodzielną wiadomość. |
To przeciążenie rozgłasza zawartość strumienia jako ramkę binarną do każdego połączenia, które przejdzie filtry kanału, protokołu, Include i Exclude. Strumień jest odczytywany od bieżącej pozycji; serwer nie przejmuje własności, więc wywołujący musi utrzymywać strumień aktywny do momentu powrotu metody Broadcast. Gdy włączone jest LoadBalancer, binarny ładunek jest przekazywany do innych węzłów, aby mogły dostarczyć go lokalnym klientom. Należy używać aSize razem z aStreaming, aby przesyłać bardzo duże ładunki strumieniowo jako wiele fragmentów WebSocket zamiast jednej nadmiernie dużej ramki.
oStream := TMemoryStream.Create;
try
oStream.LoadFromFile('payload.bin');
oServer.Broadcast(oStream);
finally
oStream.Free;
end;