neforce::http::health_check_filter类 参考

健康检查端点过滤器 更多...

#include <health_check.hpp>

类 neforce::http::health_check_filter 继承关系图:

Public 成员函数
void	add_check (const string &name, check_callback check)
	注册一个健康检查组件的回调
bool	pre_filter (http_request &request, http_response &response) override
	预处理方法
void	do_filter (http_request &, http_response &) override
	核心过滤方法
string	name () const override
	获取过滤器名称
Public 成员函数 继承自 neforce::http::http_filter
virtual void	post_filter (http_request &request, http_response &response)
	后处理方法

Public 属性
string	path {"/healthz"}
	健康检查路径
bool	show_details {true}
	是否展示详细检查结果
bool	enabled {true}
	是否启用

详细描述

健康检查端点过滤器

拦截预配置路径的 GET 请求，返回 JSON 格式的健康状态。 支持自定义健康检查回调（如数据库连接、Redis可达性等）。

响应格式： {"status":"ok","uptime":12345,"checks":{"db":"ok","redis":"ok"}} 非健康状态返回 503。

在文件 health_check.hpp 第 29 行定义.

成员函数说明

add_check()

void neforce::http::health_check_filter::add_check ( const string & name, check_callback check )

inline

注册一个健康检查组件的回调

参数

name	组件名（如 "db", "redis"）
check	返回true表示健康

在文件 health_check.hpp 第 44 行定义.

引用了 neforce::move() , 以及 name().

do_filter()

void neforce::http::health_check_filter::do_filter ( http_request & request, http_response & response )

inlineoverridevirtual

核心过滤方法

参数

request	HTTP请求
response	HTTP响应

执行实际的过滤逻辑。通常由具体处理器实现， 中间件过滤器可能不实现此方法。

实现了 neforce::http::http_filter.

在文件 health_check.hpp 第 49 行定义.

name()

string neforce::http::health_check_filter::name ( ) const

inlinenodiscardoverridevirtual

获取过滤器名称

返回

过滤器名称

重载 neforce::http::http_filter .

在文件 health_check.hpp 第 50 行定义.

被这些函数引用 add_check().

pre_filter()

bool neforce::http::health_check_filter::pre_filter ( http_request & request, http_response & response )

overridevirtual

预处理方法

参数

request	HTTP请求
response	HTTP响应

返回

返回false表示中断后续处理

在请求处理前调用，可以检查请求、修改请求或提前返回响应。

重载 neforce::http::http_filter .

---

该类的文档由以下文件生成:

• health_check.hpp