Browse Source

【修改】UM 文件细节改动

chenyong 7 năm trước cách đây
mục cha
commit
73427b07e6
5 tập tin đã thay đổi với 17 bổ sung4 xóa
  1. 13 0
      docs/api.md
  2. BIN
      docs/figures/browse-http-Server.jpg
  3. 1 1
      docs/principle.md
  4. 1 1
      docs/samples.md
  5. 2 2
      docs/user-guide.md

+ 13 - 0
docs/api.md

@@ -191,6 +191,19 @@
 | **返回**          | **描述**                           |
 | >0                | HTTP 响应状态码                     |
 
+## 获取 Content-Length 字段数据
+
+`int webclient_content_length_get(struct webclient_session *session);`
+
+该函数用于发送 GET 或 POST 请求之后,用于获取返回的 Content-Length 字段数据。
+
+| 参数              | 描述                                |
+|:------------------|:-----------------------------------|
+|session            | 当前连接会话结构体指针               |
+| **返回**          | **描述**                           |
+| >0                | Content-Length 字段数据            | 
+| <0                | 获取失败                           | 
+
 ## 下载文件到本地
 
 `int webclient_get_file(const char *URI, const char *filename);`

BIN
docs/figures/browse-http-Server.jpg


+ 1 - 1
docs/principle.md

@@ -2,7 +2,7 @@
 
  WebClient 软件包主要用于在嵌入式设备上实现 HTTP 协议,软件包的主要工作原理基于 HTTP 协议实现,如下图所示:
 
-![WebClient 软件包工作原理](./figures/browse-http-Server.jpg)
+![WebClient 软件包工作原理](./figures/browse-http-server.jpg)
 
 HTTP 协议定义了客户端如何从服务器请求数据,以及服务器如何把数据传送给客户端的方式。HTTP 协议采用了`请求/响应模型`。 客户端向服务器发送一个请求报文,请求报文包含请求的方法、URL、协议版本、请求头部和请求数据。服务器以一个状态行作为响应,响应的内容包括协议的版本、成功或者错误代码、服务器信息、响应头部和响应数据。
 

+ 1 - 1
docs/samples.md

@@ -36,7 +36,7 @@ RT-Thread online packages
 
 本例程使用的测试网站是 RT-Thread 系统的官方网站。GET 请求示例可以从网站中获取并打印显示文件内容;POST 请求示例可以上传数据到测试网站,测试网站会响应相同的数据。
 
-> HTTP 收发数据包括头部数据和实际数据两部分,以下称头部数据为 `header 数据`, 实际数据为 `body 数据`。
+> HTTP 收发数据包括头部数据和正文数据两部分,以下称头部数据为 `header 数据`,正文数据为 `body 数据`。
 
 ### GET 请求示例
 

+ 2 - 2
docs/user-guide.md

@@ -134,7 +134,7 @@ if ((resp_status = webclient_get(session, URI)) != 200)
 ```c
 int content_pos = 0;
 /* 获取接收的响应数据长度 */
-int content_length = atoi(webclient_header_fields_get(session, "Content-Length"));
+int content_length = webclient_content_length_get(session);
 
 /* 循环接收响应数据直到数据接收完毕 */
 do
@@ -309,7 +309,7 @@ webclient_close(session);
 
 - 整段数据 POST 请求
 
-    多用于上传文件较小的 POST 请求。
+    多用于上传数据量较小的 POST 请求。
 
 ```c
 char *post_data = "abcdefg";