TsgcWebSocketHTTPServer › 方法 › WriteData

WriteData 方法

通过连接 GUID 向指定的单个客户端发送 WebSocket 消息。

重载

重载 1

语法

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

参数

名称	类型	描述
`aGuid`	`const string`	客户端握手完成时服务器分配的目标连接标识符。
`aMessage`	`const string`	以 WebSocket 文本帧形式投递给该客户端的文本载荷。

返回值

当找到具有给定 GUID 的连接并且帧已传递到其套接字时为 True；当不存在匹配的活动连接时为 False。（Boolean）

备注

此重载查找 GUID 与 aGuid 匹配的 WebSocket 连接，并将文本消息发送给该单个客户端。GUID 是 TsgcWSConnection.Guid 公开的值，通常在 OnConnect 中捕获并由应用程序存储。仅已升级的 WebSocket 会话有效；属于纯 HTTP 请求的 GUID 将被拒绝，返回 False。当 QueueOptions.Text 设置为 qmNone 以外的值时，帧将进入队列并从连接线程而非调用方线程分发（当 IOHandlerOptions.IOHandlerType = iohIOCP 时不支持）。使用 Broadcast 在一次调用中触达所有活动客户端。

示例


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

重载 2

语法

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

参数

名称	类型	描述
`aGuid`	`const String`	客户端握手完成时服务器分配的目标连接标识符。
`aStream`	`TStream`	包含发送给客户端内容的源流，作为 WebSocket 二进制帧。调用方仍是流的所有者。
`aSize`	`Integer`	可选的片段大小（字节）；当大于零时，流将被分割为多个此大小的片段。使用 0（默认值）以单个帧发送整个流。
`aStreaming`	`const TwsStreaming`	分片传输的流模式（`stmNone`、`stmStart`、`stmContinue`、`stmFinish`）。默认为 `stmNone`，发送完整的独立消息。

返回值

当找到具有给定 GUID 的连接并将流交给其套接字时为 True；当不存在匹配的活动连接时为 False。（Boolean）

备注

此重载以二进制有效载荷形式，从所提供的流中读取内容，发送给单个 WebSocket 客户端。流从当前位置开始读取，服务器不取得其所有权，因此调用方必须在 WriteData 返回之前（或在队列模式下，在发送完成之前）保持流的有效性。当 QueueOptions.Binary 设置为 qmNone 以外的值时，帧将被排队并从连接线程派发，而非从调用方线程派发（当 IOHandlerOptions.IOHandlerType = iohIOCP 时不支持）。在发送需要跨多个 WebSocket 帧分片的超大有效载荷时，请将 aSize 与 aStreaming 配合使用。

示例


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

返回方法