TsgcWebSocketServerMethods › Ping

Ping 方法

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

语法

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

参数

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

备注

Ping 遍历活动连接列表,向每个客户端发送 WebSocket ping 帧,待所有帧交由底层套接字处理后返回。这是在自动 HeartBeat 机制之外,保持空闲连接活跃或手动探测存活状态的便捷方式。当配置了 HeartBeat 超时时,服务器将关闭在超时窗口内未作响应的连接;若无超时,该调用为"即发即忘"模式,任何 pong 回复将通过标准连接事件异步投递。写入过程中引发的异常将路由至 OnException

示例


oServer.Ping('keepalive');

返回方法