TsgcWebSocketHTTPServerMetodi › WriteData

WriteData Method

Invia un messaggio WebSocket a un singolo client identificato dal suo GUID di connessione.

Overload

Overload 1

Sintassi

function WriteData(const aGuid, aMessage: string): Boolean;

Parametri

NomeTipoDescrizione
aGuidconst stringIdentificatore della connessione di destinazione assegnato dal server al completamento dell'handshake del client.
aMessageconst stringPayload di testo da consegnare a quel client come frame di testo WebSocket.

Valore restituito

True quando è stata trovata una connessione con il GUID specificato e il frame è stato passato al relativo socket; False quando non esiste alcuna connessione attiva corrispondente. (Boolean)

Note

Questo overload cerca la connessione WebSocket il cui GUID corrisponde a aGuid e invia il messaggio di testo a quel singolo client. Il GUID è il valore esposto da TsgcWSConnection.Guid, tipicamente acquisito in OnConnect e memorizzato dall'applicazione. Solo le sessioni WebSocket aggiornate sono idonee; i GUID appartenenti a pure richieste HTTP vengono rifiutati e viene restituito False. Quando QueueOptions.Text è impostato su un valore diverso da qmNone, il frame viene accodato e inviato dal thread della connessione anziché dal thread del chiamante (non supportato quando IOHandlerOptions.IOHandlerType = iohIOCP). Utilizzare Broadcast per raggiungere tutti i client attivi con una singola chiamata.

Esempio


oServer.WriteData('guid', 'My First sgcWebSockets Message!.');

Sovraccarico 2

Sintassi

function WriteData(const aGuid: String; aStream: TStream; aSize: Integer = 0; const aStreaming: TwsStreaming = stmNone) : Boolean;

Parametri

NomeTipoDescrizione
aGuidconst StringIdentificatore della connessione di destinazione assegnato dal server al completamento dell'handshake del client.
aStreamTStreamStream sorgente il cui contenuto viene inviato al client come frame binario WebSocket. Il chiamante rimane il proprietario dello stream.
aSizeIntegerDimensione opzionale del frammento in byte; quando è maggiore di zero, lo stream viene suddiviso in più frammenti di questa dimensione. Utilizzare 0 (il valore predefinito) per inviare l'intero stream come un singolo frame.
aStreamingconst TwsStreamingModalità di streaming per la trasmissione frammentata (stmNone, stmStart, stmContinue, stmFinish). Il valore predefinito è stmNone, che invia un messaggio completo autonomo.

Valore restituito

True quando è stata individuata una connessione con il GUID specificato e lo stream è stato consegnato al relativo socket; False quando non esiste alcuna connessione attiva corrispondente. (Boolean)

Note

Questo overload si rivolge a un singolo client WebSocket con un payload binario letto dallo stream fornito. Lo stream viene consumato dalla sua posizione corrente e il server non ne acquisisce la proprietà, pertanto il chiamante deve mantenerlo attivo fino al ritorno di WriteData (oppure, in caso di accodamento, fino al completamento dell'invio). Quando QueueOptions.Binary è impostato su un valore diverso da qmNone, il frame viene accodato e inviato dal thread della connessione anziché dal thread del chiamante (non supportato quando IOHandlerOptions.IOHandlerType = iohIOCP). Utilizzare aSize insieme a aStreaming per l'invio di payload molto grandi che devono essere frammentati su più frame WebSocket.

Esempio


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

Torna ai Metodi