TsgcWebSocketHTTPServer › Methods › Ping

Ping 方法

向每个已连接的 WebSocket 客户端发送 WebSocket ping 帧。

语法

procedure Ping(const aText: string = '');

参数

名称	类型	描述
aText	const string	在 ping 帧内携带的可选有效载荷；传入空字符串则发送不含有效载荷的 ping。

备注

Ping 迭代活跃连接列表，向每个已升级的客户端发送 WebSocket Ping 帧，在帧移交给底层套接字后返回。普通 HTTP/HTTP2 连接被跳过，因为 WebSocket Ping 操作码仅在成功握手后才适用。这是在自动 HeartBeat 机制之外，手动保持空闲连接存活或探测存活性的便捷方式。当配置了 HeartBeat 超时时，服务器会关闭任何在窗口内未应答的连接；若没有超时，调用则是即发即忘，任何 Pong 回复都通过标准连接事件异步传递。写入时引发的异常将路由到 OnException。

示例

oServer.Ping('keepalive');

返回方法