TsgcWSAPIServer_WebPush方法 › KeepAlive

KeepAlive 方法

继承自组件框架的辅助方法,向单个 WebSocket 连接写入保活/ping 帧,以防空闲链接被代理关闭。

语法

procedure KeepAlive(const aConnection: TsgcWSConnection; const aMessage: string);

参数

名称类型描述
aConnectionconst TsgcWSConnection附加服务器持有的 WebSocket 连接,该连接应接收保活帧。
aMessageconst string保活帧内携带的可选负载;纯 ping 时传入空字符串。

备注

由基础 API 服务器类公开,适用于同一组件同时管理长期 WebSocket 会话和 Web Push HTTP 端点的场景。典型的 Web Push 流量为短暂的 HTTPS POST 请求到浏览器推送服务,不需要保活,因此通常只在通过同一监听器将客户端升级到 WebSocket 时才调用此方法。

示例

sgcWSAPIServer_WebPush1.KeepAlive(aConnection, '');

返回方法