TsgcWebSocketHTTPServer › Methoden › WriteData

WriteData Methode

Sendet eine WebSocket-Nachricht an einen einzelnen Client, der durch seine Verbindungs-GUID identifiziert wird.

Überladungen

Overload 1

Syntax

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

Parameter

Name	Typ	Beschreibung
`aGuid`	`const string`	Bezeichner der Zielverbindung, wie vom Server zugewiesen, als der Client-Handshake abgeschlossen wurde.
`aMessage`	`const string`	Text-Payload, die diesem Client als WebSocket-Textframe zugestellt werden soll.

Rückgabewert

True, wenn eine Verbindung mit der angegebenen GUID gefunden wurde und der Frame an ihren Socket übergeben wurde; False, wenn keine übereinstimmende aktive Verbindung existiert. (Boolean)

Hinweise

Diese Überladung sucht die WebSocket-Verbindung, deren GUID mit aGuid übereinstimmt, und sendet die Textnachricht an diesen einzelnen Client. Die GUID ist der von TsgcWSConnection.Guid bereitgestellte Wert, typischerweise in OnConnect erfasst und von der Anwendung gespeichert. Nur hochgestufte WebSocket-Sitzungen sind zulässig; GUIDs, die zu reinen HTTP-Anfragen gehören, werden abgelehnt und es wird False zurückgegeben. Wenn QueueOptions.Text auf einen anderen Wert als qmNone gesetzt ist, wird der Frame in eine Queue gestellt und vom Verbindungs-Thread statt vom Thread des Aufrufers versendet (nicht unterstützt, wenn IOHandlerOptions.IOHandlerType = iohIOCP). Verwenden Sie Broadcast, um jeden aktiven Client in einem Aufruf zu erreichen.

Beispiel


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

Überladung 2

Syntax

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

Parameter

Name	Typ	Beschreibung
`aGuid`	`const String`	Bezeichner der Zielverbindung, wie vom Server zugewiesen, als der Client-Handshake abgeschlossen wurde.
`aStream`	`TStream`	Quellstream, dessen Inhalt als binärer WebSocket-Frame an den Client gesendet wird. Der Aufrufer bleibt Eigentümer des Streams.
`aSize`	`Integer`	Optionale Fragmentgröße in Bytes; wenn größer als null, wird der Stream in mehrere Fragmente dieser Größe aufgeteilt. Verwenden Sie 0 (Standard), um den gesamten Stream als einzelnen Frame zu senden.
`aStreaming`	`const TwsStreaming`	Streaming-Modus für die fragmentierte Übertragung (`stmNone`, `stmStart`, `stmContinue`, `stmFinish`). Standard ist `stmNone`, was eine vollständige eigenständige Nachricht sendet.

Rückgabewert

True, wenn eine Verbindung mit der angegebenen GUID gefunden und der Stream an deren Socket übergeben wurde; False, wenn keine passende aktive Verbindung existiert. (Boolean)

Hinweise

Diese Überladung adressiert einen einzelnen WebSocket-Client mit einer aus dem bereitgestellten Stream gelesenen binären Nutzlast. Der Stream wird ab seiner aktuellen Position gelesen, und der Server übernimmt nicht den Besitz, sodass der Aufrufer ihn am Leben halten muss, bis WriteData zurückkehrt (oder, beim Queuing, bis das Senden abgeschlossen ist). Wenn QueueOptions.Binary auf einen anderen Wert als qmNone gesetzt ist, wird der Frame in eine Queue gestellt und vom Verbindungs-Thread statt vom Thread des Aufrufers versendet (nicht unterstützt, wenn IOHandlerOptions.IOHandlerType = iohIOCP). Verwenden Sie aSize zusammen mit aStreaming, wenn Sie sehr große Nutzlasten senden, die über mehrere WebSocket-Frames fragmentiert werden sollen.

Beispiel


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

Zurück zu Methoden