接口文档(范例)

《接口文档(范例)》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、接口详细设计说明书接口详细设计文档作者：唐为（为哥）审核：赵锟日期：2005-5-27　　　　　　第45页，共45页接口详细设计说明书接口详细设计文档11编写目的32名词解释33组件分布图44程序结构54.1接入处理线程类图54.2接收线程类图64.3启动控制图65程序设计说明75.1对原系统的改动75.2ThreadInSvcProcessor接入处理器85.2.1类图85.2.2时序图95.2.3流程图95.2.4ThreadInSvcProcessor类说明115.3PatternNewSyncAsyncInnerDir同异步向内

2、处理模式165.3.1类图165.3.2描述175.3.3流程图175.3.4类说明195.4ThreadReplySvcProcessor异步应答返回处理器245.4.1类图245.4.2类说明245.5ClientInfo客户端连接数据335.5.1类图335.5.2类描述335.6ClientInfoTable客户端连接数据表345.6.1类图345.6.2类描述345.7ClientInfoTableMonitor客户端连接数据表监控程序385.7.1类图38　　　　　　第45页，共45页接口详细设计说明书5.7.2类说明385

3、.8FrontMain主控程序405.8.1类间关系405.8.2流程图415.8.3类说明425.9问题44　　　　　　第45页，共45页接口详细设计说明书1编写目的预期读者：对接口行为和目的有一定了解的人背景说明n软件系统名称：接口前端接入服务器n描述<接口>接收不同商家的接入，接收数据转发给主机服务器，并同步/异步将返回数据发给接入商家的行为2名词解释nChannelBase渠道,通信基类，提供数据收发和释放的方法接口用子类实现来封装了不同通信方式目前有TCP短连接接入，从ACEMessage_Queue中读取（IPCMessag

4、eQueue->ACE_Message_Queue）nTrade*trade商家对象，代表的其实是针对该商家处理方法的集合将接入数据的商家称为服务商家而将请求面向的商家称为主机商家，主机商家负责同步/异步返回交易的应答数据给接口平台n而接口（数据交换）平台是在两者之间的交换平台n渠道工厂：把接入数据的渠道工厂统一定为服务渠道工厂，发送数据的渠道工厂统一定为主机通道工厂服务商家接口平台主机商家　　　　　　第45页，共45页接口详细设计说明书查不到,丢弃返回应答线程组ATM接入服务器ATM连接队列TCP渠道IPC消息队列渠道commserv

5、erIPC消息队列注各种服务渠道和主机通道抽象类都是相同的基类ChannelBase，只是作用不同渠道工厂生成各种渠道IPC消息队列commserver银联接入服务渠道抽象代表各种接入服务渠道接出服务渠道抽象TCP渠道IPC消息队列渠道发送请求线程组后台服务器连接监视器IPC消息队列通知清除超时间连接记录表接收线程接收IPC消息总控接入主机通道抽象IPC消息队列渠道1组件分布图ATM　　　　　　第45页，共45页接口详细设计说明书1程序结构1.1接入处理线程类图PatternNewSyncAsyncInnerDir是ProcessPat

6、tern的一个子类，实现发送主机服务器并判断同/异步返回同步直接返回给接入商家异步只做相应记录ProcessPattern是后续处理的全部流程抽象类子类实现对应不同流程ThreadInSvcProcessor是接入处理线程的主流程收数，接包无误后将处理控制权交给ProcessPattern　　　　　　第45页，共45页接口详细设计说明书1.1接收线程类图1.2启动控制图　　　　　　第45页，共45页接口详细设计说明书1程序设计说明1.1对原系统的改动n改变原有商家Trade类，不存放渠道对象在商家类中，商家类只执行商家处理，不负责渠道的

7、管理n改动原有的系统中所有模式的处理，模式处理必须对渠道的释放负责n修改MidHstChannel，添加后台服务需要的２个FML字段,这两个字段是:　　　　　　第45页，共45页接口详细设计说明书FML域名描述S_INTERF_NO接口标识号，整数。系统中接收异步响应程序的唯一编号。用于标识请求的来源，异步应答根据这个号码分发给具体的接口程序。S_TX_CTRL_ATTR交易控制属性，字符串。接口都填0，表示这是正常的交易请求。1.1ThreadInSvcProcessor接入处理器1.1.1类图　　　　　　第45页，共45页接口详细设

8、计说明书1.1.1时序图预先说明：nChannelBase渠道通信基类，提供数据收发和释放的方法接口用子类实现来封装了不同通信方式。目前有TCP短连接接入。从ACEMessage_Queue中读取（IPCM