syslog详细设计说明书.docx

1、syslog详细设计说明书文 档 编 号产品版本密级00011.0秘密产品名称： syslog共 12 页syslog软件详细设计说明书(仅供内部使用)拟制：xxx日期：2012-6-24审核：日期：yyyy-mm-dd核准：日期：yyyy-mm-dd签发：日期：yyyy-mm-dd文档版本：版权所有 XX文件修改记录修改日期版本修改页码、章节、条款修改描述作者2012-6-251.0创建创建侯潇目 录1 目的 62 代码框架描述 62.1 功能流程 62.2 源文件说明 82.3 设计说明 83 数据结构 83.1 数据结构定义 83.2 公共头文件定义 84 子模块（实体）1详细设计说明

2、94.1 数据结构 94.2 处理流程详细说明 104.3 编码设计 104.3.1 Int Initqueue（int key） 11【功 能】 114.3.2 Int Initfile（char *filename） 11【功 能】 114.3.3 Int syslog（int mode, char *fun,int line,char *text,.） 11【功 能】 114.3.4 Int msgrece（int queue_id, int file_id） 12【功 能】 125 附录 子系统定义表 12软件详细设计说明书关键词: 摘 要: 缩略语说明：缩略语英文全名中文解释参考资料

3、：华清远见-嵌入式linux应用程序开发-人民邮电出版社 2009.41 目的本文档规定了syslog项目各模块的详细设计，函数设计，数据结构。用于在linux下进行syslog的开发标准。2 代码框架描述2.1 功能流程 主框架示意图 Syslog主进程 文件操作流程图 syslog（）接口流程 2.2 源文件说明如下表格式对系统包含的源代码文件进行大致说明： 源文件名称文件描述功能模块syslog.h主功能模块头文件，包含数据结构声明，函数声明syslog.c主功能模块实现文件，包含数据结构初始化和函数定义主模块test.c测试模块test.c测试模块注：“目录结构”和“源文件说明”表格在

4、详细设计后期和编码阶段都可能被修改。 2.3 设计说明该项目设计syslog模块。本模块是在linux下为其他模块提供syslog（）接口，该接口使用消息队列机制将其他模块日志信息传递到syslog进程中，在syslog进程中完成消息解析，以及利用文件I/O操作完成对消息的存储。3 数据结构3.1 数据结构定义#define QUE_PATHNAME . /消息队列路径#define MSG_SIZE 512 /消息大小#define LOGFILE sys.log /日志文件名#define TEXT_SIZE 5 /#define MAXSIZE 1024*1024 /文件占用最大内存#d

5、efine LOG_MODE_HTTP 0#define LOG_MODE_GPS 1#define LOG_MODE_SOCKET 2#define LOG_MODE_SYS 3#define FILE_NAME_SIZE 303.2 公共头文件定义Syslog.h (路径:home/syslog/syslog.h)4 子模块（实体）1详细设计说明4.1 数据结构具体定义模块1相关的数据结构，并加以解释说明。Struct msgqueue /消息队列结构体 uint8_t *MODE_name； /出错的 Char *func_name,； uint32_t line；Char textMS

6、G_SIZE; /消息的正文4.2 处理流程详细说明(1) 发送消息 /创建消息队列读取标准输入封装消息发送消息/循环（输入，封装，发送）/关闭队列关闭程序这里描述实现这个子模块功能有几个步骤(2) 接收消息创建消息队列打开文件读取消息队列解析消息写入文件打印到终端循环（读取，解析，写入，打印）关闭文件关闭消息队列关闭程序4.3 编码设计主要函数列表格式如下：syslog.hInitqueue（）初始化队列Initfile（）初始化文件操作Msgrece（）获取消息Syslog（）外部调用接口函数，用于发送消息给syslog主进程test.cMain()测试用主函数4.3.1 Int Init

7、queue（int key） 【功 能】初始化队列【参数】Int key；/用于创建消息队列【返回值】Int 型，返回消息队列描述符，返回-1则出错【算 法】【使用说明】包含在syslog.h4.3.2 Int Initfile（char *filename） 【功 能】初始化文件操作【参数】Char *filename ；/用于传递文件名【返回值】Int 型，返回文件操作文件描述符，返回-1则出错 【使用说明】包含在syslog.h4.3.3 Int syslog（int mode, char *fun,int line,char *text,.） 【功 能】提供外部调用，外部程序可以调用此

8、函数想syslog主进程发送消息。【参数】int mode, 调用模块标示int fun, 调用函数名int line, 函数出错行数char *text, 出错信息. 可选参数【返回值】Int 型，发送成功完成返回0，否则返回-1则出错【使用说明】包含在syslog.h4.3.4 Int msgrece（int queue_id, int file_id） 【功 能】初始化队列【参数】int queue_id /传递消息队列描述符 int file_id /传递文件描述符【返回值】Int 型，发送成功完成返回0，否则返回-1则出错【使用说明】包含在syslog.h4.3.5 Int msgsend（int queue_id, int file_id） 【功 能】初始化队列【参数】int queue_id /传递消息队列描述符 int file_id /传递文件描述符【返回值】Int 型，发送成功完成返回0，否则返回-1则出错【使用说明】包含在syslog.h5 附录 子系统定义表填表说明：表格项填 写 说 明NamesyslogClass进程间通信（消息队列）Version1.0Init routineInitqueue；initfileDependance无Sequence先启动主函数（test.c中的main函数）