webclient软件包用户手册API说明

API 说明

创建会话

struct webclient_session *webclient_session_create(size_t header_sz);

创建客户端会话结构体。

关闭会话连接

int webclient_close(struct webclient_session *session);

关闭传入的客户端会话连接，并释放内存。

发送 GET 请求

int webclient_get(struct webclient_session _session, const char _URI);

发送 HTTP GET 请求命令。

发送获取部分数据的 GET 请求

int webclient_get_position(struct webclient_session _session, const char _URI, int position);

发送带有 Range 头信息的 HTTP GET 请求命令，多用于完成断点续传功能。

发送 POST 请求

int webclient_post(struct webclient_session _session, const char _URI, const char *post_data);

发送 HTTP POST 请求命令，上传数据到 HTTP 服务器。

发送数据

int webclient_write(struct webclient_session _session, const unsigned char _buffer, size_t size);

发送数据到连接的服务器。

接收数据

int webclient_read(struct webclient_session _session, unsigned char _buffer, size_t size);

从连接的服务器接收数据。

设置接收和发送数据超时时间

int webclient_set_timeout(struct webclient_session *session, int millisecond);

设置连接的接收和发送数据超时时间。

在请求头中添加字段数据

int webclient_header_fields_add(struct webclient_session _session, const char _fmt, …);

该函数用于创建会话之后和发送 GET 或 POST 请求之前，用于添加请求头字段数据。

通过字段名获取字段值数据

const char _webclient_header_fields_get(struct webclient_session _session, const char *fields);

该函数用于发送 GET 或 POST 请求之后，可以通过传入的字段名称获取对应的字段数据。

接收响应数据到指定地址

int webclientresponse(struct webclient_session _session, unsigned char *response);

该函数用于发送 GET 或 POST 请求之后， 可以接收响应数据到指定地址。

发送 GET/POST 请求并接收响应数据

int webclientrequest(const char _URI, const char _header, const char _post_data, unsigned char *response);

获取 HTTP 响应状态码

int webclient_resp_status_get(struct webclient_session *session);

该函数用于发送 GET 或 POST 请求之后，用于获取返回的响应状态码。

获取 Content-Length 字段数据

int webclient_content_length_get(struct webclient_session *session);

该函数用于发送 GET 或 POST 请求之后，用于获取返回的 Content-Length 字段数据。

下载文件到本地

int webclient_get_file(const char _URI, const char _filename);

从 HTTP 服务器下载文件并存放到本地。

上传文件到服务器

int webclient_post_file(const char _URI, const char _filename, const char *form_data);

从 HTTP 服务器下载文件并存放到本地。

原作者：RT-Thread软件包手册