sese::net::http::Servlet类 参考

HTTP 应用 更多...

#include <Controller.h>

Public 类型
using	Ptr = std::shared_ptr<Servlet>
using	Callback = std::function<void(HttpServletContext &)>

Public 成员函数
	Servlet ()
	Servlet (RequestType expect, const std::string &url)
void	setCallback (Callback callback)
const std::string &	getUri () const
RequestType	getExpectType () const
auto &	getExpectQueryArgs () const
auto &	getExpectHeaders () const
void	requiredQueryArg (const std::string &arg)
void	requiredHeader (const std::string &arg)
void	invoke (HttpServletContext &ctx) const
Servlet &	operator= (Callback callback)

Private 属性
std::string	uri
	注册路径
RequestType	expect_type
	预期的请求类型，不满足则 403
std::set< std::string >	expect_query_args
	预期的查询字符串参数，不满足则 400
std::set< std::string >	expect_headers
	预期的头部参数，不满足则 400
Callback	callback
	请求处理回调函数，不满足则 500

详细描述

HTTP 应用

成员类型定义说明

Callback

using sese::net::http::Servlet::Callback = std::function<void(HttpServletContext &)>

Ptr

using sese::net::http::Servlet::Ptr = std::shared_ptr<Servlet>

构造及析构函数说明

Servlet() [1/2]

sese::net::http::Servlet::Servlet

(

)

引用了 expect_type, sese::net::http::GET , 以及 uri.

Servlet() [2/2]

sese::net::http::Servlet::Servlet	(	RequestType	expect,
		const std::string &	url )

成员函数说明

getExpectHeaders()

auto & sese::net::http::Servlet::getExpectHeaders ( ) const

inlinenodiscard

引用了 expect_headers.

getExpectQueryArgs()

auto & sese::net::http::Servlet::getExpectQueryArgs ( ) const

inlinenodiscard

引用了 expect_query_args.

getExpectType()

RequestType sese::net::http::Servlet::getExpectType ( ) const

inlinenodiscard

引用了 expect_type.

getUri()

const std::string & sese::net::http::Servlet::getUri ( ) const

inlinenodiscard

引用了 uri.

被这些函数引用 sese::service::http::HttpServer::regServlet().

invoke()

void sese::net::http::Servlet::invoke

(

HttpServletContext &

ctx

)

const

引用了 callback(), sese::net::http::HttpServletContext::getReq() , 以及 sese::net::http::HttpServletContext::getResp().

operator=()

Servlet & sese::net::http::Servlet::operator= ( Callback callback )

inline

引用了 callback , 以及 setCallback().

requiredHeader()

void sese::net::http::Servlet::requiredHeader

(

const std::string &

arg

)

requiredQueryArg()

void sese::net::http::Servlet::requiredQueryArg

(

const std::string &

arg

)

setCallback()

void sese::net::http::Servlet::setCallback

(

Callback

callback

)

引用了 callback().

被这些函数引用 operator=().

类成员变量说明

callback

Callback sese::net::http::Servlet::callback

private

请求处理回调函数，不满足则 500

被这些函数引用 operator=().

expect_headers

std::set<std::string> sese::net::http::Servlet::expect_headers

private

预期的头部参数，不满足则 400

被这些函数引用 getExpectHeaders().

expect_query_args

std::set<std::string> sese::net::http::Servlet::expect_query_args

private

预期的查询字符串参数，不满足则 400

被这些函数引用 getExpectQueryArgs().

expect_type

RequestType sese::net::http::Servlet::expect_type

private

预期的请求类型，不满足则 403

被这些函数引用 getExpectType() , 以及 Servlet().

uri

std::string sese::net::http::Servlet::uri

private

注册路径

被这些函数引用 getUri() , 以及 Servlet().

---

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

• sese/net/http/Controller.h
• sese/net/http/Controller.cpp