sese::net::http::Requestable类 参考

可请求接口 更多...

#include <Requestable.h>

类 sese::net::http::Requestable 继承关系图:

Public 类型
using	WriteCallback = std::function<int64_t(const void *, size_t)>
using	ReadCallback = std::function<int64_t(void *, size_t)>
Public 类型 继承自 sese::io::InputStream
typedef std::shared_ptr< InputStream >	Ptr
Public 类型 继承自 sese::io::OutputStream
typedef std::shared_ptr< OutputStream >	Ptr

Public 成员函数
	~Requestable () override=default
virtual bool	request ()=0
virtual int	getLastError ()=0
virtual std::string	getLastErrorString ()=0
int64_t	read (void *buf, size_t len) override=0
int64_t	write (const void *buf, size_t len) override=0
Request::Ptr &	getRequest ()
Response::Ptr &	getResponse ()
void	setReadData (io::PeekableStream *read_data, size_t expect_total)
void	setWriteData (io::OutputStream *write_data)
void	setReadCallback (const ReadCallback &read_callback, size_t expect_total)
void	setWriteCallback (const WriteCallback &write_callback)
void	reset ()
	重置 body 相关设置
Public 成员函数 继承自 sese::io::InputStream
virtual	~InputStream () noexcept=default
Public 成员函数 继承自 sese::io::OutputStream
virtual	~OutputStream () noexcept=default
int64_t	write (const std::string_view &buffer)
int64_t	write (const text::StringView &buffer)
template<typename T >
int64_t	write (std::vector< T > &buffer)
template<typename T , size_t N>
int64_t	write (std::array< T, N > &buffer)

Protected 属性
Request::Ptr	req = nullptr
Response::Ptr	resp = nullptr
size_t	expect_total = 0
io::PeekableStream *	read_data = nullptr
io::OutputStream *	write_data = nullptr
WriteCallback	write_callback
ReadCallback	read_callback

详细描述

可请求接口

成员类型定义说明

ReadCallback

using sese::net::http::Requestable::ReadCallback = std::function<int64_t(void *, size_t)>

WriteCallback

using sese::net::http::Requestable::WriteCallback = std::function<int64_t(const void *, size_t)>

构造及析构函数说明

~Requestable()

sese::net::http::Requestable::~Requestable ( )

overridedefault

成员函数说明

getLastError()

virtual int sese::net::http::Requestable::getLastError ( )

pure virtual

获取最后一次错误

返回

最后一次错误

在 sese::internal::net::http::HttpClientImpl 内被实现.

getLastErrorString()

virtual std::string sese::net::http::Requestable::getLastErrorString ( )

pure virtual

获取最后一次错误信息

返回

最后一次错误信息

在 sese::internal::net::http::HttpClientImpl 内被实现.

getRequest()

Request::Ptr & sese::net::http::Requestable::getRequest ( )

inline

获取请求头集合

返回

请求头集合

引用了 req.

getResponse()

Response::Ptr & sese::net::http::Requestable::getResponse ( )

inline

获取响应头集合

返回

响应头集合

引用了 resp.

read()

int64_t sese::net::http::Requestable::read ( void * buf, size_t len )

overridepure virtual

实现了 sese::io::InputStream.

在 sese::internal::net::http::HttpClientImpl , 以及 sese::internal::net::http::HttpSSLClientImpl 内被实现.

request()

virtual bool sese::net::http::Requestable::request ( )

pure virtual

执行请求

返回

请求状态

在 sese::internal::net::http::HttpClientImpl 内被实现.

reset()

void sese::net::http::Requestable::reset ( )

inline

重置 body 相关设置

引用了 expect_total, read_callback, read_data, req, resp, write_callback , 以及 write_data.

被这些函数引用 sese::internal::net::http::HttpClientImpl::HttpClientImpl() , 以及 sese::internal::net::http::HttpClientImpl::request().

setReadCallback()

void sese::net::http::Requestable::setReadCallback ( const ReadCallback & read_callback, size_t expect_total )

inline

设置请求 body 外部来源，此选项将在请求完成后重置

参数

read_callback	body 读取来源回调函数，返回读取大小，读取不完全则终止传输
expect_total	body 预计大小

引用了 expect_total , 以及 read_callback.

setReadData()

void sese::net::http::Requestable::setReadData ( io::PeekableStream * read_data, size_t expect_total )

inline

设置请求 body 外部来源，此选项将在请求完成后重置

参数

read_data	body 读取来源
expect_total	body 预计大小

引用了 expect_total , 以及 read_data.

setWriteCallback()

void sese::net::http::Requestable::setWriteCallback ( const WriteCallback & write_callback )

inline

设置响应 body 外部目的地，此选项将在请求完成后重置

参数

write_callback

接收 body 目的地回调函数，返回写入大小，写入不完全则终止传输

引用了 write_callback.

setWriteData()

void sese::net::http::Requestable::setWriteData ( io::OutputStream * write_data )

inline

设置响应 body 外部目的地，此选项将在请求完成后重置

参数

write_data

接收 body 目的地

引用了 write_data.

write()

int64_t sese::net::http::Requestable::write ( const void * buf, size_t len )

overridepure virtual

实现了 sese::io::OutputStream.

在 sese::internal::net::http::HttpClientImpl , 以及 sese::internal::net::http::HttpSSLClientImpl 内被实现.

类成员变量说明

expect_total

size_t sese::net::http::Requestable::expect_total = 0

protected

被这些函数引用 sese::internal::net::http::HttpClientImpl::request(), reset(), setReadCallback(), setReadData(), sese::internal::net::http::HttpClientImpl::writeBodyByCallback() , 以及 sese::internal::net::http::HttpClientImpl::writeBodyByData().

read_callback

ReadCallback sese::net::http::Requestable::read_callback

protected

被这些函数引用 sese::internal::net::http::HttpClientImpl::request(), reset(), setReadCallback() , 以及 sese::internal::net::http::HttpClientImpl::writeBodyByCallback().

read_data

io::PeekableStream* sese::net::http::Requestable::read_data = nullptr

protected

被这些函数引用 reset(), setReadData() , 以及 sese::internal::net::http::HttpClientImpl::writeBodyByData().

req

Request::Ptr sese::net::http::Requestable::req = nullptr

protected

被这些函数引用 getRequest(), sese::internal::net::http::HttpClientImpl::HttpClientImpl(), sese::internal::net::http::HttpClientImpl::request(), reset() , 以及 sese::internal::net::http::HttpClientImpl::writeBodyByAuto().

resp

Response::Ptr sese::net::http::Requestable::resp = nullptr

protected

被这些函数引用 getResponse(), sese::internal::net::http::HttpClientImpl::HttpClientImpl(), sese::internal::net::http::HttpClientImpl::request() , 以及 reset().

write_callback

WriteCallback sese::net::http::Requestable::write_callback

protected

被这些函数引用 sese::internal::net::http::HttpClientImpl::readBodyByCallback(), sese::internal::net::http::HttpClientImpl::request(), reset() , 以及 setWriteCallback().

write_data

io::OutputStream* sese::net::http::Requestable::write_data = nullptr

protected

被这些函数引用 sese::internal::net::http::HttpClientImpl::readBodyByData(), reset() , 以及 setWriteData().

---

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

• sese/net/http/Requestable.h