TsgcWebSocketServer_HTTPAPI › Methods › Broadcast

Broadcast Método

Envia a mesma mensagem a todos os clientes conectados, opcionalmente filtrados por canal, protocolo ou lista de GUIDs de conexão.

Overloads

Overload 1

Sintaxe

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

Parâmetros

Name	Type	Descrição
`aMessage`	`const string`	Payload de texto entregue a cada cliente correspondente como um frame de texto WebSocket.
`aChannel`	`const string`	Quando não vazio, a mensagem é enviada apenas a clientes assinantes do canal informado.
`aProtocol`	`const string`	Quando não vazia, a mensagem é enviada apenas a clientes que utilizam o subprotocolo WebSocket fornecido.
`Exclude`	`const String`	Lista separada por vírgulas de GUIDs de conexão que devem ser ignorados por este broadcast.
`Include`	`const String`	Lista de GUIDs de conexão separados por vírgula que restringe o broadcast a esse subconjunto; ignorado quando vazio.

Observações

Esta sobrecarga envia um frame de texto a cada conexão WebSocket ativa que corresponda aos filtros fornecidos. Os filtros são combinados com semântica AND: uma conexão recebe a mensagem apenas quando satisfaz cada filtro não vazio, e nunca é alcançada quando seu GUID aparece em Exclude. Quando Asynchronous está habilitado, a chamada retorna antes que cada escrita do HTTP.sys seja concluída e o evento OnAsynchronous reporta a conclusão; quando desabilitado, a chamada é executada na thread do chamador e retorna assim que os frames são enfileirados para cada socket. Erros de escrita por conexão são reportados através de OnException sem abortar o broadcast.

Exemplo


oServer.Broadcast('Hello From Server');

Sobrecarga 2

Sintaxe

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

Parâmetros

Name	Type	Descrição
`aStream`	`TStream`	Stream de origem cujo conteúdo é entregue a cada cliente correspondente como um quadro binário WebSocket. O chamador permanece o proprietário do stream.
`aChannel`	`const string`	Quando não vazio, a mensagem é enviada apenas a clientes assinantes do canal informado.
`aProtocol`	`const string`	Quando não vazia, a mensagem é enviada apenas a clientes que utilizam o subprotocolo WebSocket fornecido.
`Exclude`	`const String`	Lista separada por vírgulas de GUIDs de conexão que devem ser ignorados por este broadcast.
`Include`	`const String`	Lista de GUIDs de conexão separados por vírgula que restringe o broadcast a esse subconjunto; ignorado quando vazio.
`aSize`	`const Integer`	Tamanho de fragmento opcional em bytes; quando maior que zero, cada cliente recebe o stream dividido em fragmentos deste tamanho. Utilize 0 (o padrão) para enviar o stream inteiro como um único frame.
`aStreaming`	`const TwsStreaming`	Modo de streaming para transmissão fragmentada (`stmNone`, `stmStart`, `stmContinue`, `stmFinish`). Padrão `stmNone`, que envia uma mensagem completa e independente.

Observações

Esta sobrecarga transmite o conteúdo do stream como um frame binário a cada conexão que passa pelos filtros de canal, protocolo, Include e Exclude. O stream é lido a partir de sua posição atual; o servidor não assume a propriedade, então o chamador deve manter o stream vivo até que Broadcast retorne (ou, quando Asynchronous está habilitado, até que o evento OnAsynchronous reporte a conclusão). Utilize aSize junto com aStreaming para transmitir cargas úteis muito grandes como múltiplos fragmentos WebSocket em vez de um frame superdimensionado, o que é especialmente útil no HTTP.sys, onde o kernel faz buffer dos dados de saída.

Exemplo


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

Voltar para Métodos