通讯模块接口文档.doc

（通讯模块） 接口说明书 编号： 编制： 姚成松 日期：2003-08-07 审核： 日期： 批准： 日期： 　 　 文档修订记录 变更 序号 文档版本号 变更内容简述 变更日期 变更人  1. 执行平台和IDS接口说明 4 1.1接口Start说明 4 1.2接口TransmitFile说明 4 1.3接口SendData说明 5 1.4接口GetPeerIp说明 5 1.5接口CloseConnection说明 6 1.6接口Connect说明 6 1.7接口CRecvFile说明 7 1.8接口SetRecvFuncPointer说明 7 1.9接口Start( for udp)说明 8 1.10接口SendData(for udp)说明 9 1.11接口EndWorking(for udp)说明 9 2. 数据结构说明 10 3. 兼容win98系统通讯接口说明(ZZMonitor 客户端) 11 3.1接口ServerStart说明 11 3.2接口SendData说明 12 3.3接口TransmitFile说明 12 3.4接口DisConnect说明 12 3.5接口Connect说明 13 3.6接口Start(for udp)说明 14 3.7接口SendData(for udp)说明 14 3.8接口SendData(for udp)说明 15 3.9接口StopWorking (for udp)说明 15 4. 兼容win98的模块数据结构说明 16  执行平台和IDS接口说明 用户处理数据的回调函数: typedef BOOL (CALLBACK *RecvData)(IN char *Recvbuf, IN int iBufLen, IN LPVOID lpVoid ); 说明:该函数再收到通信对方发送来的全部数据后调用 Recvbuf是接收到的数据 nBufLen 是数据的长度 lpVoid是通讯内部使用的数据结构,调用时不用关心它是什么,简单将其传给通信的其他接口即可 文件传送结果处理回调函数说明: typedef void (CALLBACK *cbTransFileRst)(LPCTSTR lpszFileName , LPCTSTR lpszDesIp, DWORD dwReason , DWORD dwValue , LPVOID lpVoid ); 说明:该函数在发送和接收文件结束后调用,通知用户此次文件传送是成功还是失败 lpszFileName: 传送的文件名 lpszDesIp: 传送对方的ip地址 dwReason: 调用该回调要通知用户的事件,表示是发送还是接收 dwValue: 表示操作的结果是失败还是成功 lpVoid:内部使用(保留) dwReason值: TRANS_CB_RECV_RESULT 接收文件结果通知 TRANS_CB_RECV_PROGRESS 接收文件时报告进度(保留) TRANS_CB_SEND_RESULT 发送文件的结果通知 TRANS_CB_SEND_PROGRESS 发送文件的进度报告(保留) dwValue值: TRANS_FAILED 传送失败 TRANS_SUCCESS 传送成功 实例mycb(“Setup.exe”, “192.168.0.1”, TRANS_CB_RECV_RESULT, TRANS_SUCCESS) 表示,从192.168.0.1 接收 文件setup.exe 成功 1.1接口Start说明 //描述： 监听服务器启动函数 1.1.1接口Start函数原型 int Start(IN LPVOID lpRecvFun, IN int iBindPort) 1.1.2接口Start参数说明 //函数名：Start //输入参数： lpRecvFun---回调函数 // iBindPort---服务监听端口 //输出参数： 无 //外部变量： 无 //返回值： 成功TRUE,失败FALSE 1.1.3与接口Start相关联的模块 执行平台服务控制模块 1.2接口TransmitFile说明 //描述： 向通讯对方发送文件 1.2.1接