TsgcWebSocketHTTPServer › Methods › Broadcast
Wysyła tę samą wiadomość WebSocket do wszystkich połączonych klientów, opcjonalnie filtrowanych według kanału, protokołu lub listy 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 WebSocket obsługiwanego przez serwer HTTP, które spełnia podane filtry. Filtry są łączone semantyką AND: połączenie otrzymuje wiadomość tylko wtedy, gdy spełnia każdy niepusty filtr, i nigdy nie jest osiągane, gdy jego GUID pojawia się w Exclude. Czyste żądania HTTP/HTTP2 są ignorowane, ponieważ Broadcast jest skierowany wyłącznie do klientów, którzy ukończyli uzgadnianie WebSocket. Gdy włączony jest LoadBalancer, wywołanie jest przekazywane do całego klastra, dzięki czemu zdalne węzły również dostarczają wiadomość swoim lokalnym klientom. Wywołanie działa w wątku wywołującego i zwraca wynik po przekazaniu ramek do każdego gniazda; błędy zapisu na poszczególnych połączeniach 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 rozsyła zawartość strumienia jako ramkę binarną do każdego połączenia WebSocket hostowanego przez serwer HTTP, które przechodzi przez filtry kanału, protokołu, Include i Exclude. Strumień jest odczytywany od bieżącej pozycji; serwer nie przejmuje jego własności, dlatego wywołujący musi utrzymywać strumień przy życiu do momentu zwrócenia Broadcast. Gdy włączony jest LoadBalancer, binarny ładunek jest przekazywany do innych węzłów, aby mogły ponownie dostarczyć go do swoich lokalnych klientów. Należy użyć aSize razem z aStreaming, aby przesyłać strumieniowo bardzo duże ładunki jako wiele fragmentów WebSocket zamiast jednej nadmiernej ramki.
oStream := TMemoryStream.Create;
try
oStream.LoadFromFile('payload.bin');
oServer.Broadcast(oStream);
finally
oStream.Free;
end;