nchan_eventsource_ping_data

指令 `nchan_eventsource_ping_data` 指定在使用 EventSource 协议向订阅者发送的保活 ping 时的数据负载。

语法nchan_eventsource_ping_data data;
默认值none
上下文server, location, if in location
参数1

说明

nchan_eventsource_ping_data 指令在 Nchan 中使用,Nchan 是一个可扩展的 pub/sub 服务模块,用于在 NGINX 中促进大量并发连接之间的实时通知和交互。当在合适的上下文中启用时,该指令定义在 EventSource 保活 ping 期间发送的内容。此功能确保客户端与服务器之间的连接保持活动状态,防止超时,并允许服务器在不需要持续请求—响应循环的情况下向客户端推送更新。通过配置此指令,用户可以自定义 ping 的负载,具有多种用途,例如健康检查、提供版本标识符,或发送客户端可以使用的元数据而无需额外的往返请求。该指令的参数应为定义 ping 数据内容的数据字符串。恰当利用此指令可以通过保持通信通道活跃并提供有用数据显著改善用户体验。该指令可以在不同上下文中配置,包括 server、location,或 location 内的 conditional。这种灵活的应用使开发者能够根据不同路由或响应条件的具体需求优化服务器行为。

配置示例

location /events {
    nchan_eventsource_ping_data '{"ping": "keep-alive"}';
    # Other Nchan configurations...
}

如果您发送结构化数据,请确保 ping 数据格式为有效的 JSON。

注意 ping 的频率;将其设置得过低可能会导致服务器出现意外负载。

← 返回所有指令