TsgcWebSocketHTTPServerYöntemler › Broadcast

Broadcast Yöntem

Aynı WebSocket mesajını bağlı tüm istemcilere, isteğe bağlı olarak kanala, protokole veya bağlantı GUID listesine göre filtrelenmiş olarak gönderir.

Aşırı Yüklemeler

Aşırı Yükleme 1

Sözdizimi

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

Parametreler

NameTypeAçıklama
aMessageconst stringEşleşen her istemciye WebSocket metin çerçevesi olarak teslim edilen metin yükü.
aChannelconst stringBoş olmadığında, mesaj yalnızca verilen kanala abone olan istemcilere gönderilir.
aProtocolconst stringBoş olmadığında, mesaj yalnızca verilen WebSocket alt protokolünü kullanan istemcilere gönderilir.
Excludeconst StringBu yayında atlanması gereken bağlantı GUID'lerinin virgülle ayrılmış listesi.
Includeconst StringYayını (broadcast) o alt kümeyle sınırlayan, virgülle ayrılmış bağlantı GUID'leri listesi; boş olduğunda göz ardı edilir.

Remarks

Bu aşırı yükleme, sağlanan filtrelerle eşleşen, HTTP sunucusu tarafından barındırılan her etkin WebSocket bağlantısına bir metin çerçevesi gönderir. Filtreler VE semantiğiyle birleştirilir: bir bağlantı yalnızca boş olmayan her filtreyi karşıladığında mesajı alır ve GUID'i Exclude içinde göründüğünde asla ulaşılmaz. Saf HTTP/HTTP2 istekleri göz ardı edilir çünkü Broadcast yalnızca WebSocket handshake'ini tamamlayan istemcileri hedefler. LoadBalancer etkinleştirildiğinde çağrı küme genelinde iletilir, böylece uzak düğümler de mesajı yerel istemcilerine teslim eder. Çağrı, çağıranın iş parçacığında çalışır ve çerçeveler her sokete teslim edildiğinde döner; bağlantı başına yazma hataları, yayını durdurmadan OnException aracılığıyla raporlanır.

Örnek


oServer.Broadcast('Hello From Server');

Overload 2

Sözdizimi

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

Parametreler

NameTypeAçıklama
aStreamTStreamİçeriği eşleşen her istemciye WebSocket ikili çerçevesi (binary frame) olarak iletilen kaynak stream'i. Çağıran, stream'in sahibi olmaya devam eder.
aChannelconst stringBoş olmadığında, mesaj yalnızca verilen kanala abone olan istemcilere gönderilir.
aProtocolconst stringBoş olmadığında, mesaj yalnızca verilen WebSocket alt protokolünü kullanan istemcilere gönderilir.
Excludeconst StringBu yayında atlanması gereken bağlantı GUID'lerinin virgülle ayrılmış listesi.
Includeconst StringYayını (broadcast) o alt kümeyle sınırlayan, virgülle ayrılmış bağlantı GUID'leri listesi; boş olduğunda göz ardı edilir.
aSize const Integerİsteğe bağlı bayt cinsinden parça boyutu; sıfırdan büyük olduğunda her istemci stream'i bu boyutta parçalara bölünmüş olarak alır. Tüm stream'i tek bir çerçeve olarak göndermek için 0 (varsayılan) kullanın.
aStreamingconst TwsStreamingParçalı iletim için akış modu (stmNone, stmStart, stmContinue, stmFinish). Tam, bağımsız bir mesaj gönderen stmNone varsayılandır.

Remarks

Bu aşırı yükleme, stream içeriğini, kanal, protokol, Include ve Exclude filtrelerini geçen HTTP sunucusu tarafından barındırılan her WebSocket bağlantısına ikili bir çerçeve olarak yayın yapar. Stream geçerli konumundan okunur; sunucu sahipliği almaz, bu nedenle çağıran, Broadcast dönene kadar stream'i canlı tutmalıdır. LoadBalancer etkinleştirildiğinde, ikili yük diğer düğümlere iletilir, böylece bunlar yerel istemcilerine yeniden teslim edebilir. Çok büyük yükleri tek bir aşırı boyutlu çerçeve yerine birden çok WebSocket parçası olarak stream etmek için aSize değerini aStreaming ile birlikte kullanın.

Örnek


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

Yöntemlere Dön