概要设计说明书--模版v10.doc

软件 模块 概要设计说明书软件 模块 概要设计说明书 项目名称项目名称 作 者 完成日期 2007 07 04 签 收 人 签收日期 2007 07 05 修改情况记录 文档编号文档编号 ITL ND007ITL ND007 日期日期 2007 07 05 版本号修改批准人修改人安装日期签收人 目目 录录 软件 模块 概要设计说明书软件 模块 概要设计说明书 1 1 1 引言引言 1 1 1 1 编写目的 1 1 2 相关文档 1 1 3 参考资料 1 1 4 术语和缩写词 2 2 2 需求列表需求列表 2 2 2 1 功能需求 2 2 2 性能需求 2 3 3 总体结构设计总体结构设计 2 2 3 1 总体结构和模块外部设计 2 3 2 本模块内子模块划分 2 3 3 本模块内子模块列表 4 4 4 接口设计接口设计 4 4 4 1 外部接口 详细描述各个接口 4 4 2 内部接口 详细描述各个接口 4 4 3 用户接口 8 5 5 模块内各个子模块的描述模块内各个子模块的描述 8 8 5 1 接口处理子模块描述 8 5 2 消息发送子模块描述 8 5 3 消息接收子模块描述 11 6 6 本模块基本数据结构简要设计本模块基本数据结构简要设计 1414 6 1数据结构 1 TTMLPEER 14 6 2数据结构 2 TTMLCONN 14 6 3数据结构 3 TTMLMCAST 14 6 4数据结构 4 TTMLUDPMCAST 14 6 5数据结构 5 TTMLMSGBLOCK 14 6 6数据结构 6 TTMLLOCALPARA 15 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 1 页 1 引言引言 1 1 编写目的 传输匹配层作为 ForCES 协议中间件的一部分 主要负责传递协议层之间的 ForCES 消息 本文档全面介绍了传输匹配层的组织结构 以及各模块的功能 模块之间的接口和实现机制 此概要设计说明书的读者是总体设计师和程序员 以进一步进行详细设计 和代码编写 1 2 相关文档 序号文档名称版本号作者备 注 1 ForCES 系统软件架构设计 V1 0 李传煌 2 基于 TCP UDP 的传输匹配层软件模块需求说明书 V1 0 陈建群 3 ForCES 中间件协议层软件模块需求说明书 V1 0 张翁平 表格 1 相关文档 1 3 参考资料 序 号 名称 版 本 号 作者 发表 日期 出版单位 来源 备 注 Requirements for Separation of IP Control and Forwarding H Khosravi T Anderson Nov 2003 http www ietf org rfc rfc3654 txt Forwarding and Control Element Separation ForCES Framework L Yang R Dantu T Anderson R Gopal Apr 2004 http www ietf org rfc rfc3746 txt ForCES Protocol Specification 10A Doria R Haas J Hadi Salim H Khosravi W M Wang May 2007 http www ietf org internet drafts draft ietf forces protocol 10 txt 4ForCES Transport Mapping Layer TML Service Primitives 01W M Wang J Hadi Salim Alex Audu Feb 2007 http www ietf org internet drafts draft ietf forces tmlsp 01 txt 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 2 页 5TCP and UDP based ForCES Protocol TML over IP Networks 02Weiming Wang Ligang Dong Bin Zhuge Mar 2007 http tools ietf o rg id draft wang forces iptml 02 txt 表格 2 参考资料 1 4 术语和缩写词 序 号 术语 缩写词 说明备注 ForCESForwarding and Control Element Separation 转发件与控制件分 离 TMLTransport Mapping Layer 传输匹配层 PLProtocol Layer 协议层 4CEControl Element 控制件 5FEForwarding Element 转发件 6OSCSLOperation System and Common Supporting Layer 表格 3 术语和缩写词 2 2 需求列表需求列表 2 1 功能需求 2 2 性能需求 3 3 总体结构设计总体结构设计 3 1 总体结构和模块外部设计 3 2 本模块内子模块划分 本模块分为接口处理模块 消息发送模块 消息接收模块 消息调度模块 拥塞监控模块和日志管理模块 6 个子模块 模块间关系和数据流图如下图所示 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 3 页 PL TML服服务务接接口口 CEM FEM CEM TML API FEM TML API TML MSG 消消 息息 处处 理理 模模 块块 拥拥塞塞监监 控控模模块块 消消息息调调 度度模模块块 至至网网络络IP消消息息包包 TML MSG 消消息息发发 送送模模块块 OSCSL OSCSL API PL TML API 消消息息接接 收收模模块块 日日 志志 管管 理理 模模 块块 消消息息调调度度模模块块接接口口处处理理模模块块 图 1 TML 内部子模块 3 3 本模块内子模块列表 子模块名称子模块功能说明及设计考虑 接口处理模块 对来自应用的服务请求进行处理 根据应 用请求的类型 数据或控制请求 分别对 其进行不同的处理 消息发送模块 一个线程或任务 对发送消息缓存进行调 度 根据调度结果 将消息包通过 socket 发送 并对消息发送流量进行统计 发生 连接断开事件时 上报事件 消息接收模块 一个线程或任务 从网络中接收消息 并 把消息放入接收消息缓存或通过消息到达 事件传递给 PL 上报连接断开事件 拥塞监控模块 一个线程或任务 订阅拥塞事件上报时运 行 统计消息流量 根据消息流量判断拥 塞事件发生或消失 上报拥塞事件的产生 和消失 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 4 页 消息调度模块 根据消息类型和消息优先级 对消息进行 调度 日志管理模块 记录 TML 发生的各种各样的事情 通过它 来检查网络阻塞发生的时间 启动 关闭 时间 实时检测的系统状态 故障等 表格 4 子模块列表 4 4 接口设计接口设计 4 1 外部接口 详细描述各个接口 4 2 内部接口 详细描述各个接口 编 号 接口名称接口功能接口形式 1 消息发送模块接口 TMLMsgSend 将发送缓存中的消息通过网络发 送 创建新线程 函 数调用 2 消息接收模块接口 TMLMsgRecv 从网络中不间断地接收消息 并 将消息以回调函数形式传递给 PL 或放入接收消息缓存 创建新线程 函 数调用 3 消息调度模块 TMLMsgSchedule 根据消息优先级和类型进行调度 函数调用 4 拥塞监控模块接口 TMLCongWatch 对发送消息流量进行统计 当拥 塞事件发生或消失时进行上报 创建新线程 函 数调用 5TMLOpenLog 打开日志函数调用 6TMLCloseLog 关闭日志函数调用 7TMLLogErr 记录等级为 ERR 的日志函数调用 8TMLLogWarn 记录等级为 WARN 的日志函数调用 9TMLLogInfo 记录等级为 INFO 的日志函数调用 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 5 页 10TMLLogNotice 记录等级为 NOTICE 的日志函数调用 11TMLLogDebug 记录等级为 DEBUG 的日志函数调用 表格 5 内部接口列表 4 2 1 接口处理子模块与消息发送子模块之间的接口 void TMLMsgSend void 功能 将发送缓存中的消息通过网络发送 返回值 无 4 2 2 接口处理子模块与消息接收子模块之间的接口 void TMLMsgRecv void 功能 从网络中不间断地接收消息 并将消息以回调函数形式传递给 PL 或放入 接收消息缓存 返回值 无 4 2 3 接口处理子模块与拥塞监控子模块之间的接口 void TMLCongWatch void 功能 对发送消息流量进行统计 当拥塞事件发生或消失时进行上报 返回值 无 4 2 4 接口处理子模块与消息调度子模块之间的接口 ossl int32 TMLMsgSchedule ossl int8 Flags 0 对发送消息缓存进行调度 1 对接收缓存进行调 度 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 6 页 功能 根据消息优先级和类型进行消息调度 返回值 消息缓存编号 成功 1 失败 4 2 5 发送消息子模块与消息调度子模块之间的接口 ossl int32 TMLMsgSchedule ossl int8 Flags 0 对发送消息缓存进行调度 1 对接收缓存进行调 度 功能 根据消息优先级和类型进行消息调度 返回值 消息缓存编号 成功 1 失败 4 2 6 日志管理子模块提供的接口 1 打开日志 TTMLLog TMLOpenLog const ossl int8 ProgName 程序名称 ossl int32 Flags 输出形式 功能 打开一个日志 不存在时创建一个 返回值 TTMLLog 指针 成功 1 失败 typedef struct TMLLog 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 7 页 const ossl int8 ProgName 调用该日志的程序名称 ossl int32 Flags 输出标志 0 x00 NOLOG 0 x01 FILE 0 x02 SYSLOG 0 x04 STDOUT 0 x08 STDERR FILE Fp 日志句柄 ossl int8 Filename 日志文件名 TTMLLog 2 关闭日志 void TMLCloseLog TTMLLog PLog 功能 关闭一个日志 返回值 无 3 记录等级为 ERR 的日志 void TMLLogErr TTMLLog PLog const ossl int8 PFormat 功能 返回值 无 4 记录等级为 WARN 的日志 void TMLLogWarn TTMLLog PLog const ossl int8 PFormat 功能 返回值 无 5 记录等级为 INFO 的日志 void TMLLogInfo TTMLLog PLog const ossl int8 PFormat 功能 返回值 无 6 记录等级为 NOTICE 的日志 void TMLLogNotice TTMLLog PLog const ossl int8 PFormat 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 8 页 功能 返回值 无 7 记录等级为 DEBUG 的日志 void TMLLogDebug TTMLLog PLog const ossl int8 PFormat 功能 返回值 无 4 3 用户接口 无 5 5 模块内各个子模块的描述模块内各个子模块的描述 5 1 接口处理子模块描述 5 2 消息发送子模块描述 5 2 1 子模块名称 消息发送模块 5 2 2 子模块功能 对发送消息缓存进行调度 根据调度结果 通过 socket 发送消息 发送成 功时统计消息发送流量 发送失败时上报连接断开事件 5 2 3 子模块中的数据流图 发送消息缓存消息调度 组播包发 送 单播包发 送 组播包 单播包 IP消息包 IP消息包 图 2 消息发送模块数据流图 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 9 页 5 2 4 输入项 发送消息缓存 5 2 5 输出项 IP 消息包 5 2 6 处理过程 用流程图描述 入入口口 调调用用消消息息调调度度模模块块 根根据据ID判判断断是是 否否是是组组播播包包 组组播播包包发发送送 单单播播包包发发送送 发发送送成成功功 发发送送流流量量统统计计 连连接接断断开开事事件件上上 报报 出出口口 Y N Y N 处处于于打打开开状状 态态 Y N 图 3 消息发送模块流程图 5 2 7 模块的主子程序调用图 TMLMsgSend TMLMsgUnicastSend TMLMsgMcastSend TMLMsgStat 图 4 消息发送模块主子程序调用图 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 10 页 5 2 8 函数说明 函数名输入参数返回值功能描述 TMLMsgSendvoidvoid 调用消息调度模块 根据 调度结果 将消息包通过 socket 发送 统计消息发送 流量 上报连接断开事件 TMLMsgUnicastSendossl uint32 DestID ossl int8 Msg ossl int32 Msglen ossl int32 MsgType 成功或失败单播消息发送 TMLMsgMcastSendossl uint32 DestID ossl int8 Msg ossl int32 Msglen ossl int32 MsgType 成功或失败组播消息发送 TMLMsgStatossl int32 MsgType ossl int32 MsgLen 成功或失败对发送成功的消息按照消 息类型进行流量统计 表格 6 函数列表 5 3 消息接收子模块描述 5 3 1 子模块名称 消息接收模块 5 3 2 子模块功能 从网络中接收消息 并把消息放入接收消息缓存或通过消息到达事件传递 给 PL 接收到连接断开信号时向 PL 上报连接断开事件 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 11 页 5 3 3 子模块中的数据流图 判断select 返回结果 Select返回结果 接受连接 接收TCP 消息 接收UDP 消息 接收消息缓存 连接信息 TCP连接请求 TCP消息 UDP消息 图 5 消息接收模块数据流图 5 3 4 输入项 IP 消息包 5 3 5 输出项 接收消息缓存 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 12 页 5 3 6 处理过程 用流程图描述 入入口口 出出口口 FE连连接接请请求求 CE TML Y N Y N TCP消消息息 接接收收TCP消消息息 Y N 接接收收UDP消消息息 TML处处于于打打开开 状状态态 N Y 处处理理FE连连接接 Select 图 6 消息接收模块流程图 5 3 7 模块的主子程序调用图 TMLMsgRecv TMLAccept TMLUDPRecv TMLTCPRecv 图 7 消息接收模块主子程序调用图 5 3 8 函数说明 函数名输入参数返回值功能描述 TMLMsgRecvvoid 无从网络中接收消息 并把消息放 基于 TCP UDP 的传输匹配层 TML 模块概要设计说明书 V1 0 浙江工商大学网络与通信工程研究 所 第 13 页 入接收消息缓存或通过消息到达 事件传递给 PL 上报连接断开 事件 TMLAcceptFEstruct ossl sockaddr in4