docs: sync up line number for api reference

This commit is contained in:
unknown
2022-05-07 18:40:41 +08:00
parent 179ea878c7
commit 5a1c257f96
7 changed files with 75 additions and 48 deletions
@@ -27,12 +27,14 @@ HTTP Server 组件提供了在 ESP32 上运行轻量级 Web 服务器的功能
return ESP_OK;
}
/* URI 处理函数,在客户端发起 POST /uri 请求时被调用 */
/* URI 处理函数,在客户端发起 POST/uri 请求时被调用 */
esp_err_t post_handler(httpd_req_t *req)
{
/* 定义 HTTP POST 请求数据的目标缓存区
* httpd_req_recv() 只接收 char* 数据,但也可以是任意二进制数据(需要类型转换)
* 对于字符串数据,null 终止符会被省略,content_len 会给出字符串的长度 */
* httpd_req_recv() 只接收 char* 数据,但也可以是
* 任意二进制数据(需要类型转换)
* 对于字符串数据,null 终止符会被省略,
* content_len 会给出字符串的长度 */
char content[100];
/* 如果内容长度大于缓冲区则截断 */
@@ -43,10 +45,12 @@ HTTP Server 组件提供了在 ESP32 上运行轻量级 Web 服务器的功能
/* 检查是否超时 */
if (ret == HTTPD_SOCK_ERR_TIMEOUT) {
/* 如果是超时,可以调用 httpd_req_recv() 重试
* 简单起见,这里我们直接响应 HTTP 408(请求超时)错误给客户端 */
* 简单起见,这里我们直接
* 响应 HTTP 408(请求超时)错误给客户端 */
httpd_resp_send_408(req);
}
/* 如果发生了错误,返回 ESP_FAIL 可以确保底层套接字被关闭 */
/* 如果发生了错误,返回 ESP_FAIL 可以确保
* 底层套接字被关闭 */
return ESP_FAIL;
}
@@ -64,7 +68,7 @@ HTTP Server 组件提供了在 ESP32 上运行轻量级 Web 服务器的功能
.user_ctx = NULL
};
/* POST /uri 的 URI 处理结构 */
/* POST/uri 的 URI 处理结构 */
httpd_uri_t uri_post = {
.uri = "/uri",
.method = HTTP_POST,
@@ -127,7 +131,7 @@ HTTP 服务器具有长连接的功能,允许重复使用同一个连接(会
esp_err_t adder_post_handler(httpd_req_t *req)
{
/* 如果会话上下文不存在则新建一个 */
/* 上下文不存在会话,则新建一个 */
if (! req->sess_ctx) {
req->sess_ctx = malloc(sizeof(ANY_DATA_TYPE)); /*!< 指向上下文数据 */
req->free_ctx = free_ctx_func; /*!< 释放上下文数据的函数 */
@@ -148,6 +152,12 @@ HTTP 服务器具有长连接的功能,允许重复使用同一个连接(会
详情请参考位于 :example:`protocols/http_server/persistent_sockets` 的示例代码。
Websocket 服务器
----------------
HTTP 服务器组件提供 websocket 支持。可以在 menuconfig 中使用 :ref:`CONFIG_HTTPD_WS_SUPPORT` 选项启用 websocket 功能。有关如何使用 websocket 功能,请参阅 :example:`protocols/http_server/ws_echo_server` 目录下的示例代码。
API 参考
--------