tea (1) 基本模块

前面叙述了编写 configure.ac 和 Makefile.am，现在开始正式介绍 tea 的基本模块。

 

tea/inc目录下的头文件，就是tea基本模块的描述，主要包括：

    sock_srv.h 声明一个多线程的tcp server接口，实现对应 tea/src/sock_srv.c 其中使用了一个简单的线程池，如果平台支持openssl，同时支持tcp ssl server.

#ifndef _sock_srv__hh #define _sock_srv__hh /** 一个多线程的 tcp server, 每个链接使用一个独立的工作线程, 这样虽然效率相比 select/poll 低了些, 但 模型更简单, 清晰, 每个连接上执行的操作互不干扰. */ #include "tea_types.h" #ifdef __cplusplus extern "C" { #endif // c++ /** 当收到链接请求时, 调用 每个 new connection 使用不同的工作线程, 只要该函数返回, 这个线程将被回收 @param opaque: 来自 ts_open() @param conn: 对应一个 client channel, 使用 tc_xxx 访问功能 @param from: client ip @param port: 对应 client port */ typedef void (*PFN_ts_new_connection)(void *opaque, tea_conn_t conn, const char *from, int port); /** 创建一个对应端口的 tcp server @param port: listen port @param proc: callback for a new connection @param opaque: for callback user data @param cert_file: 如果 SUPPORT_OPENSSL, 则为 server 证书 @param key_file: 如果 SUPPORT_OPENSSL, 则为 server 私钥 @return 0 失败 */ tea_tcpd_t ts_open (int port, PFN_ts_new_connection proc, void *opaque, const char *cert_file, const char *key_file); /** 停止 server */ void ts_close (tea_tcpd_t ts); #ifdef __cplusplus } #endif // c++ #endif // sock_srv.h 

        在 sock_srv.c 的实现中，同时启动多个工作线程，每个线程的基本逻辑如下：

                 work thread proc:

                          while !exit do

                                   acquire lock

                                   work_sock = accept()

                                   release lock

                                   call PFN_ts_new_connection

                          end while

                 end proc

 

    http_msg.h 声明对一个 http request/response msg 的操作，和从字节流中解析 http msg 的方法；实现对应 tea/src/http_msg.c

#ifndef _http_msg__hh #define _http_msg__hh /** 声明 http msg 基本操作 */ #include "tea_types.h" #ifdef __cplusplus extern "C" { #endif // c++ /** 准备一个空的 http msg 结构 */ tea_msg_t msg_create (); /** 释放 msg 对应的所有资源 */ void msg_release (tea_msg_t msg); /** 设置 msg start line */ void msg_set_startline (tea_msg_t msg, const char *p1, const char *p2, const char *p3); /** 获取 msg start line, 如果没有设置, 返回 "", 而不是 0 */ void msg_get_startline (tea_msg_t msg, const char **p1, const char **p2, const char **p3); /** 检查 msg 是否完整, 如果包含 body, 将使用 Content-Length 检查 */ int msg_is_complete (tea_msg_t msg); /** 添加一个 header */ void msg_set_header (tea_msg_t msg, const char *key, const char *value); /** 类似 printf 设置 header, 为了方便 */ void msg_setf_header (tea_msg_t msg, const char *key, const char *value_fmt, ...); /** 获取 header, 如果key不存在, 返回 0 */ const char * msg_get_header (tea_msg_t msg, const char *key); /** 删除一个 key */ void msg_del_header (tea_msg_t msg, const char *key); /** 获取 msg header enum */ tea_msg_enum_t msg_header_enum_create (tea_msg_t msg); /** 释放 msg header enum */ void msg_header_enum_release (tea_msg_enum_t msg_header_enum); /** reset */ void msg_header_enum_reset (tea_msg_enum_t msg_header_enum); /** 返回下一个 header */ int msg_header_enum_next (tea_msg_enum_t msg_header_enum, const char **key, const char **value); /** 获取 body 长度 */ size_t msg_get_body_size (tea_msg_t msg); /** 获取 body 指针, 返回 body 长度 */ size_t msg_get_body (tea_msg_t msg, const void **body); /** 追加 body, 返回追加后的长度 */ size_t msg_append_body (tea_msg_t msg, const void *body, size_t len); /** 设置 body, 将覆盖原来的 body */ size_t msg_set_body (tea_msg_t msg, const void *body, size_t len); /** 序列化 msg, 用完后, 必须调用 msg_free() 释放 data, 返回序列长度 */ size_t msg_dump (tea_msg_t msg, void **data); void msg_free (void *data); /** 从字符流中, 解析得到 msg @param saved_msg: 上次解析留下的不完整的 msg, 第一次解析, 使用 0 @param data: 数据 @param len: data 长度 @param used: 本次解析实际使用的字节数目 @return 总是有效的 msg 实例, 使用 msg_is_complete() 检查是否完整 @warning 如果 saved_msg 完整, 将直接返回 saved_msg, used = 0 */ tea_msg_t msg_parser_parse (tea_msg_t saved_msg, void *data, size_t len, size_t *used); #ifdef __cplusplus } #endif // c++ #endif // http_msg.h  

      http msg parser 使用一个简单的状态机，每写入状态机一个字节，状态机判断状态转换，其实这里需要改进的，当状态为PS_BODY时，应该根据Content-Length，一次尽量写入多个字节，以提高效率。

 

    http_srv.h 基于 sock_srv，声明一个 httpd 接口，基本与 sock_srv.h 没啥区别，对应 tea/src/http_srv.c 实现

#ifndef _http_srv__hh #define _http_srv__hh /** 基于 sock_srv 的 httpd */ #include "tea_types.h" #ifdef __cplusplus extern "C" { #endif // c++ /** 当收到一个 http request 时, 调用 @param connection: 相当于当前链接, 用于调用 hs_conn_xxx() 函数 @param opaque: 来自 hs_open() @param req: 来自 client 的 msg, 使用 msg_xxx() 获取信息 @param res: 一个空的 msg, 一般需要使用 msg_xxx() 写入信息 @param res_has_sent: 0 表示希望由hs发送 res, 1 表示实现者已经发送了 @return: 将决定后续处理: 0: 表示希望断开此链接 1: 表示希望保留此链接 */ typedef int(*PFN_http_new_request)(tea_conn_t connection, void *opaque, const tea_msg_t req, tea_msg_t res, int *res_has_sent); /** 打开一个 http srv */ tea_httpd_t hs_open (int port, PFN_http_new_request proc, void *opaque); void hs_close (tea_httpd_t hs); /** 使用 connection 发送数据, 在 PFN_http_new_request() 调用, 将直到发送所有, 或者错误 */ int hs_conn_sendn (tea_conn_t conn, const void *data, int len); /** 方便发送 res */ int hs_conn_send_msg (tea_conn_t conn, const void *msg); /** 接收 connection 的数据, 直到收到 len, 或者错误返回 */ int hs_conn_readn (tea_conn_t conn, void *data, int len); #ifdef __cplusplus } #endif // c++ #endif // http_srv.h  

    特别的，使用 tcp_client 接口用于封装 socket 和 ssl 的内部实现。

 

    tea_httpd_plugin_inf.h 插件接口，声明兼容插件必须支持的接口。

#ifndef _tea_httpd_plugin_inf__hh #define _tea_httpd_plugin_inf__hh /** 声明用于 http_srv 的 plugin 接口 */ #include "tea_types.h" #ifdef __cplusplus extern "C" { #endif // c++ /** new_request() 返回值 */ enum Tea_new_req_ret { RC_CLOSE = 0x00000001, // server将中断这个连接 RC_RES_SENT = 0x00000002, // server将不再发送 res RC_NOT_MATCHED= 0x80000000, // plugin不处理该request }; /** 要求 plugin 实现的函数，可选部分，可以保持 0 */ struct TeaPluginFunc { /** 返回plugin版本，可选实现 */ void (*version)(int *major, int *minor); /** 返回plugin描述，可选实现 */ const char *(*desc)(); /** 处理 http request， 必须实现 @param opaque: register()时指定，用于传输 private data @param conn: 可以直接用于 tc_sendn(), tc_readn() @param url: req 中的 startline 的第二部分 @param req: req msg @param res: 一个基本的 200 的 response，一般需要实现中填充 @return RC_XXX 的位或，server将根据改返回值，决定执行的操作 */ enum Tea_new_req_ret (*new_request)(void *opaque, tea_conn_t conn, const char *url, tea_msg_t req, tea_msg_t res); }; /** server 实现的功能 */ struct TeaServerFunc { /** 当前server 实现版本 @param major: 出参，返回主版本号 @param minor: 出参，返回次版本号 */ void (*version)(int *major, int *minor); /** 当前 server 描述 */ const char *(*desc)(); /** 注册 TeaPluginFunc @param opaque: plugin实现者提供，存储私有数据 @param sfuncs: plugin实现的函数 @param base_path: 对应 url 中的 path 部分支持： "/ptz" 匹配 http://192.168.12.83:1669/ptz/ctrl?... "*" 匹配所有url @return > 0 成功， < 0失败，此时 plugin 的 tea_httpd_plugin_open()应该返回-1 */ int (*register_plugin)(void *opaque, struct TeaPluginFunc *sfuncs, const char *base_path); }; /** 标准plugin使用动态库加载，必须引出此函数，并且名字为 "tea_httpd_plugin_open" @param sfuncs: 供plugin使用的server端函数 @return >0 成功， <0 将加载失败 */ typedef int (*PFN_httpd_plugin_open)(struct TeaServerFunc *sfuncs); #ifdef __cplusplus } #endif // c++ #endif // tea_httpd_plugin_inf.h  

    这里很直白，没啥可说的，提供 version() 的主要目的是为了扩展方便，当需要增加方法时，在结构后面增加就是了，通过version()检查，能够做到二进制兼容的。

 

    [plugin loader] 还没有开始写呢，目的是动态加载插件。行了，没写的就不说了.... 下次吧。