http_filter类 参考

HTTP过滤器基类 更多...

#include <http_filter.hpp>

类 http_filter 继承关系图:

Public 成员函数
virtual void	do_filter (http_request &request, http_response &response)=0
	核心过滤方法
virtual bool	pre_filter (http_request &request, http_response &response)
	预处理方法
virtual void	post_filter (http_request &request, http_response &response)
	后处理方法
virtual NEFORCE_NODISCARD string	name () const
	获取过滤器名称

详细描述

HTTP过滤器基类

所有HTTP过滤器的抽象基类，定义了过滤器的生命周期方法。

过滤器生命周期：

1. pre_filter：请求处理前调用
2. do_filter：实际处理
3. post_filter：响应发送前调用

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

成员函数说明

do_filter()

virtual void http_filter::do_filter ( http_request & request, http_response & response )

pure virtual

核心过滤方法

参数

request	HTTP请求
response	HTTP响应

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

在 authentication_filter, cors_filter, logging_filter, rate_limit_filter , 以及 static_file_filter 内被实现.

name()

virtual NEFORCE_NODISCARD string http_filter::name ( ) const

inlinevirtual

获取过滤器名称

返回

过滤器名称

被 authentication_filter, cors_filter, logging_filter, rate_limit_filter , 以及 static_file_filter 重载.

在文件 http_filter.hpp 第 86 行定义.

post_filter()

virtual void http_filter::post_filter ( http_request & request, http_response & response )

inlinevirtual

后处理方法

参数

request	HTTP请求
response	HTTP响应

在响应发送前调用，可以修改响应头或正文。

被 logging_filter 重载.

在文件 http_filter.hpp 第 80 行定义.

pre_filter()

virtual bool http_filter::pre_filter ( http_request & request, http_response & response )

inlinevirtual

预处理方法

参数

request	HTTP请求
response	HTTP响应

返回

返回false表示中断后续处理

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

被 authentication_filter, cors_filter, logging_filter, rate_limit_filter , 以及 static_file_filter 重载.

在文件 http_filter.hpp 第 71 行定义.

---

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

• http_filter.hpp