TsgcWebSocketProxyServer › 方法 › Ping

Ping 方法

向代理浏览器端的每个已连接客户端发送 WebSocket ping 帧。

语法

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

参数

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

备注

Ping 遍历活动 WebSocket 连接列表，向每个客户端发送 WebSocket ping 帧，并在帧交给底层套接字后返回。ping 仅针对每个隧道的 WebSocket 一侧，因为配对的上游 TCP 连接是不承载 WebSocket 控制帧的原始字节流。这是保持空闲浏览器连接活跃或手动探测存活性的便捷方式。任何 pong 回复都将通过标准连接事件异步送达，写入时引发的异常将路由至 OnException。

示例

oServer.Ping('keepalive');

返回方法