CommonLib使用说明文档.docVIP

CommonLib1 使用说明文档 目 录 1 概述 3 2 接口说明 4 2.1 数据结构类 4 2.1.1 链表 4 2.1.2 数组 8 2.1.3 队列 11 2.1.4 哈希表 13 2.1.5 多叉树 18 2.2 程序组件类 21 2.2.1 内存池 21 2.2.2 线程池 23 2.2.3 读写锁 24 2.2.4 压缩 25 2.2.5 定时器 26 2.3 网络通讯类 27 2.3.1 基本协议通讯 27 2.3.2 http协议 29 2.4 其它 31 2.4.1 获得版本 31  概述 CommonLib是一套包含数据结构、网络连接、压缩等功能的跨平台通用开发库，用于在软件开发中实现多种固定功能模块，对软件开发项目起到减少开发时间、统一开发风格、合理划分结构和提高软件质量等作用。使用过程中无需关注各模块的基础数据结构如何搭建关联，仅需要通过接口直接使用即可。 通用库当前版本支持的平台如表1所示，表内为已经过实际测试的，理论上经过编译后应该可以工作在全系列类unix系统的衍生系统的应用层，部分接口不能在内核态工作，后续章节中有详细描述。 表1 平台支持信息表 OS Linux Windows Mac OS X VERSION Fc7(u/k) Fc11(u/k) Fc14(u/k) Es4(u/k) Xp sp2(u) Xp sp3(u) Vistea (u) 7 (u) Leopard 10.5.x (u) NOTES u:OS user level k:OS kernel level 通用库目录及文件说明如下图所示，第一层目录为操作系统目录，区分操作系统平台类型，包括linux、windows和mac，第二层为操作系统的版本目录，区分操作系统的版本，例如linux目录下分为es4、fc7、fc11、fc14等。linux操作系统目录的第三层目录用于区分应用层和内核层不同的版本，例如es4目录下有kernel代表内核版本，user代表应用层版本；windows目录下分为xp、vista、7等。Windows操作系统目录的第三层目录用于区分vc6和vc2008不同版本，例如xp目录下有vc6和vc2008目录，第四层用于区分调试版本和正式版本，例如xp\vc2008目录下有debug和release两个版本实际使用时选择对应的目录下的版本即可。 图1 通用库目录图 接口说明 数据结构类 链表 描述：用于存储数据的双向环链表，线程上下文安全。 数据： COMMONLIST结构体对象表示一个链表结构，每次使用前可声明一个COMMONLIST变量或者给PCOMMONLIST类型指针动态分配空间。 3.接口： int ComInitList(PCOMMONLIST plist,int handle) 输入参数：plist 链表结构指针，handle 内存池句柄，使用已分配的内存池时此参数填写内存池句柄，不使用内存池时填写-1。 返回值：0 成功，-1 失败。 int ComFreeList(PCOMMONLIST plist,int (*func)(void* s1,void* s2),void* s2) 描述：链表释放函数，链表使用完毕后调用此函数。 输入参数：plist 链表结构指针，func释放链表结构时的用户回调函数，当链表释放时，遍历每个链表节点内容时调用一次，一般用于对用户自定义的数据的释放处理等用户自定义操作，s2传递给回调函数的用户自定义参数，不需要时可填NULL。 返回值：0 成功，-1 失败。 void ComLockList(PCOMMONLIST plist,int role) 描述：链表加锁函数，用于多线程编程过程中对临界链表资源的保护。同一个此类型锁不支持多次加锁。 输入参数：plist 链表结构指针，role 加锁类型 0 读锁 1写锁。 void ComUnLockList(PCOMMONLIST plist,int role) 描述：链表解锁函数。 输入参数：plist 链表结构指针，role 解锁类型 0 读锁 1写锁。 int ComGetListLength(PCOMMONLIST plist) 描述：获得链表长度。 输入参数：plist 链表结构指针。 返回值：=0 链表内节点数量。 int ComGetListNode(PCOMMONLIST plist,int (*func)(void* s1,void* s2),void*s2,void** node,int* listindex) 描述：通过用户回调函数获得链表指定节点。 输入参数：plist 链表结构指针，func用户回调函数，链表会根据该回调函数的返回值确认查找是否成功（返回1成功