力控dbcomm接口说明.docx
- 文档编号:3744917
- 上传时间:2022-11-25
- 格式:DOCX
- 页数:19
- 大小:266.77KB
力控dbcomm接口说明.docx
《力控dbcomm接口说明.docx》由会员分享,可在线阅读,更多相关《力控dbcomm接口说明.docx(19页珍藏版)》请在冰豆网上搜索。
力控dbcomm接口说明
DB接口模块设计
1DbComm设计
1.1DbComm通讯机制
1.1.1通讯架构
DbComm为Db通讯组件的核心模块,其他模块实现如DbApi和DbOcx,DbSdk都是在此核心模块基础上的二次封装,DbComm采用静态库的方式提供。
DbComm和Db进行通讯,分为两种模式:
本地模式:
采用窗口消息机制(COPYDATA)与本地DB进行通讯
远程模式:
采用TCP方式与远程NetServer进行通讯
同一时刻只能运行于一种模式,本地或者远程
不论本地还是远程模式,处理模块内部都将开辟两个线程:
数据处理线程:
负责连接DB,初始化DB,数据包的解析等工作
回调函数线程:
负责按照需求进行回调(连接状态变化回调,数据变化回调)
所有调用函数都采用同步机制实现,发送给DB相应的请求以后将等待一个超时时间,如果DB返回数据,调用函数成功,如果超时,调用函数失败。
为了防止交换数据过大,网络速率引起的时间延误,DBCOMM在收到正确的数据包后将刷新超时时间,超时时间按照接收到最后一个正确的数据包计算,但最大时间不超过超时时间的10倍。
1.1.2数据流程
与DB通讯流程(本地模式和远程模式的差别只是在于通讯链路的区别,通讯机制是相同的)
DB初始化:
只有DB初始化完成以后,向DB发送各种命令才有意义
当客户端注册数据通知以后,注册的数据点在获取数据时,默认从DbComm的内部缓存中读取数据(也可以强制从DB读取数据),以加快数据的获取速度
对于注册点,内部采用计数机制,每一个数据点内部都有一个计数器,代表这个数据点的注册次数,注销的时候只有在计数为0时,才真正注销计数。
典型的应用为,有A、B两任务,A任务使用Tag1-10,10个点的数据,B任务使用Tag5-15,10个点的数据,两任务有5个点的交叉,这样一个任务不用去分辨那些点和其他任务交叉,主需要注册10个点即可,在DbComm内部会保存,Tag5-10的注册计数为2,只有调用两次注销函数,才会真正将点从缓存中去掉,这样会简化各个任务的处理机制。
客户端注册数据时,可以动态增加或者删除注册点,以保证DbComm的灵活性,客户端注册数据成功后,可以调用函数读取所有注册点的数据
客户端注册数据后,变化通知或者读取数据都按照序号的形式读取,以加快数据解析速度,也提供其他的方式读取数据(按照点名等)
DbComm不再使用Variant数据类型,采用自定义的数据结构来存储Db数据库中的三种数据类型(整形,浮点,字符串)
1.1.3数据变化通知机制
DB的变化通知机制是,当数据变化是将变化数据保存于DB内部,外部程序例如DBCOMM周期的访问DB的变化数据。
为了最大程度保证变化数据不丢失,又不占用太大内存,DBCOMM在DB内部开辟了一个单向列表来保存变化数据。
DB为所有的注册点开辟一个统一的缓存区(按照类型分为两种缓存,字符串型和浮点型),缓存区的大小等于注册点个数(最小开辟200),这样保证每个点都有一个位置来保存自己的变化数据,又不至于太浪费内存
每一个注册点都保存一份数据信息,包括有多少个变化数据,第一个变化数据在缓存中的位置,最后一个变化数据在缓存中的位置
初始状态时缓存是有个有序的单向链表
变化数据都按照先后顺序填入链表中,当缓存区全部用完以后,取出数据个数最多的一个点,例如Tag2.pv,将它的数据缓存区占用一个,用于保存最新的变化数据,这样保证最大程度的利用缓存,又保证每个点的数据变化不会因为缓存长度的限制被丢失。
2DbComm接口
2.1内存管理
2.1.1DbCommMallocMem
语法:
char*DbCommMallocMem(unsignedlongLen);
说明:
开辟内存
参数:
开辟内存长度
返回值:
开辟的内存指针
备注:
为了保证DbComm和外部调用者之间的内存管理方式一直,调用接口设置缓存交互时,需要调用该函数开辟内存
2.1.2DbCommFreeMem
语法:
voidDbCommFreeMem(char*pBuf);
说明:
释放内存
参数:
内存指针
返回值:
无
备注:
为了保证DbComm和外部调用者之间的内存管理方式一直,调用接口设置缓存交互时,需要调用该函数释放内存
2.2DbComm基本函数
2.2.1new_DbComm
语法:
CDbComm*new_DbComm(intnType);
说明:
新建DbComm对象
参数:
nType调用类型(用于区别调用者身份,DLL,OCX,SDK)
返回值:
DbComm对象指针
备注:
无
2.2.2delete_DbComm
语法:
voiddelete_DbComm(CDbComm*pDbComm);
说明:
销毁DbComm对象
参数:
DbComm对象指针
返回值:
无
备注:
无
2.2.3CDbComm对象SetCallerPtr方法
语法:
voidSetCallerPtr(unsignedlongptr);
说明:
传入调用者指针
参数:
ptr调用者指针
返回值:
无
备注:
无
2.2.4CDbComm对象SetStatusChangeFunc方法
语法:
voidSetStatusChangeFunc(STATUS_CHANGE_FUNChFunc);
说明:
设置状态变化时的回调函数
参数:
hFunc回调函数指针指针
返回值:
无
备注:
回调函数STATUS_CHANGE_FUNC,具体定义为
typedefvoid(*STATUS_CHANGE_FUNC)(
unsignedlongptr1,//ptr1指向本对象的指针
unsignedlongptr2,//ptr2指向调用者的指针
unsignedlongStatus//组件状态);
2.2.5CDbComm对象SetDataChangeFunc方法
语法:
voidSetDataChangeFunc(STATUS_CHANGE_FUNChFunc);
说明:
设置数据变化后的回调函数
参数:
hFunc回调函数指针指针
返回值:
无
备注:
回调函数STATUS_CHANGE_FUNC,具体定义为
typedefvoid(*STATUS_CHANGE_FUNC)(
unsignedlongptr1,//ptr1指向本对象的指针
unsignedlongptr2,//ptr2指向调用者的指针
unsignedlongTagCount,//变化数据个数
unsignedlong*RegTagNo,//注册点序号
unsignedlong*RegTagData,//注册点附加数据
DbData**TagData//数据);
DbTagData为数据库数据通用结构,其结构定义如下
typedefstruct
{
unsignedcharType;
union{
longlData;
PSTRstrData;
doubledbData;
}Data;
}DbTagData,*PDbTagData;
2.2.6CDbComm对象ConnectServer方法
语法:
boolConnectServer(unsignedlongPortNo,constchar*RemoteAddr,constchar*LocalAddr=NULL,unsignedlongLocalPortNo=0);
说明:
创建服务器(远程模式)
参数:
PortNo服务器端口
RemoteAddr服务器IP地址
LocalAddr本地IP地址(只限于双网卡,同网段使用)
LocalPortNo本地端口(一般情况无需修改,默认0即可)
返回值:
创建连接对象是否成功
备注:
连接服务器,采用异步模式,是否已经连接上,需要等待“连接成功”回调函数或者判断IsConnected
启动连接服务器后,如果遇外部情况链路中断后,模块会自动重试直到调用DisConnect方法
2.2.7CDbComm对象ConnectServer方法
语法:
boolConnectServer();
说明:
创建服务器(本地模式)
参数:
无
返回值:
创建连接对象是否成功
备注:
连接服务器,采用异步模式,是否已经连接上,需要等待“连接成功”回调函数或者判断IsConnected
启动连接服务器后,如果遇外部情况链路中断后,模块会自动重试直到调用DisConnect方法
2.2.8CDbComm对象IsConnected方法
语法:
boolIsConnected();
说明:
取得客户端连接状态
参数:
无
返回值:
客户端是否连接
备注:
无
2.2.9CDbComm对象DisConnect方法
语法:
voidDisConnect();
说明:
断开客户端连接
参数:
无
返回值:
无
备注:
无
2.2.10CDbComm对象GetStatus方法
语法:
unsignedlongGetStatus();
说明:
得到组件状态
参数:
无
返回值:
组件状态
备注:
无
2.2.11CDbComm对象SetTimeOut方法
语法:
voidSetTimeOut(unsignedlongTimeOut);
说明:
设置消息发送,处理超时时间
参数:
TimeOut超时时间(单位:
毫秒)
返回值:
无
备注:
默认值为10000(10秒)
2.2.12CDbComm对象GetTimeOut方法
语法:
unsignedlongGetTimeOut();
说明:
取得消息发送,处理超时时间
参数:
无
返回值:
超时时间(单位:
毫秒)
备注:
默认值为10000(10秒)
2.2.13CDbComm对象GetLastError方法
语法:
voidGetLastError(char*str,unsignedlonglen);
说明:
取得最后一个错误的信息
参数:
str字符缓存区
len缓存区长度
返回值:
无
备注:
错误信息格式为:
错误号+空格+错误字符串
2.3DbComm数据点信息函数
2.3.1CDbComm对象GetTagCount方法
语法:
longGetTagCount();
说明:
得到数据库点个数
参数:
无
返回值:
数据库点个数
备注:
无
2.3.2CDbComm对象GetTagInfo方法
语法:
longGetTagInfo(unsignedlongTagCount,unsignedlong*pTagNo,pTagName*pTagName,unsignedlong*pTagArea,unsignedlong*pTagType);
说明:
获取数据点的信息
参数:
TagCount点个数[IN]
pTagNo点序号[OUT]
pTagName点名[OUT]
pTagArea点区域[OUT]
pTagType点类型[OUT]
返回值:
获得的数据点个数
备注:
DbTagName为数据库点名描述,数据结构定义如下
typedefstruct
{
charName[20];
}TagName,*PTagName;
2.3.3CDbComm对象GetTypeCount方法
语法:
longGetTypeCount();
说明:
获取数据点类型个数
参数:
无
返回值:
数据点类型的个数
备注:
无
2.3.4CDbComm对象GetTypeInfo方法
语法:
longGetTypeInfo(unsignedlongTypeCount,unsignedlong*pTypeNo,unsignedlong*pParCount);
说明:
获取数据点类型的信息
参数:
TypeCount点类型个数[IN]
pTypeNo点类型序号[OUT]
pParCount点参数个数[OUT]
返回值:
获得的数据点类型的个数
备注:
无
2.3.5CDbComm对象GetParInfo方法
语法:
longGetParInfo(unsignedlongTypeNo,unsignedlongParCount,unsignedlong*pParNo,unsignedlong*pParType,ParName*pParName);
说明:
获取数据点参数的信息
参数:
TypeNo点类型序号[IN]
ParCount点参数个数[IN]
pParNo点参数序号[OUT]
pParName点参数名称[OUT]
pParType点参数数据类型[OUT]
返回值:
获得数据点参数的个数
备注:
ParName为数据库点类型参数描述,数据结构定义如下
typedefstruct
{
charName[12];
}ParName,*PParName;
2.3.6CDbComm对象GetParNo方法
语法:
longGetParNo(unsignedlongTypeNo,unsignedlongParCount,ParName*pParName,unsignedlong*pParNo);
说明:
获取数据点参数的序号
参数:
TypeNo点类型[IN]
ParCount点参数个数[IN]
pParName点参数名称[IN]
pParNo点参数序号[OUT]
返回值:
取得的点参数序号的个数
备注:
无
2.3.7CDbComm对象GetParName方法
语法:
longGetParName(unsignedlongTypeNo,unsignedlongParCount,unsignedlong*pParNo,ParName*pParName);
说明:
获取数据点参数的名称
参数:
TypeNo点类型[IN]
ParCount点参数个数[IN]
pParNo点参数序号[IN]
pParName点参数名称[OUT]
返回值:
取得的点参数名称的个数
备注:
无
2.3.8CDbComm对象GetParType方法
语法:
longGetParType(unsignedlongTypeNo,unsignedlongParCount,unsignedlong*pParNo,unsignedlong*pParType);
说明:
获取数据点类型的参数序号
参数:
TypeNo点类型[IN]
ParCount点参数个数[IN]
pParNo点参数序号[IN]
pParType点参数类型[OUT]
返回值:
取得的点参数类型的个数
备注:
无
2.3.9CDbComm对象GetTagNo方法
语法:
longGetTagNo(unsignedlongTagCount,TagName*pTagName,unsignedlong*pTagNo);
说明:
获取数据点的序号
参数:
TagCount点个数[IN]
pTagName点名[IN]
pTagNo点序号[OUT]
返回值:
数据点的个数
备注:
无
2.3.10CDbComm对象GetTagName方法
语法:
longGetTagName(unsignedlongTagCount,unsignedlong*pTagNo,TagName*pTagName);
说明:
获取数据点的名字
参数:
TagCount点个数[IN]
pTagNo点序号[IN]
pTagName点名[OUT]
返回值:
数据点的个数
备注:
无
2.3.11CDbComm对象GetTagArea方法
语法:
longGetTagArea(unsignedlongTagCount,unsignedlong*pTagNo,unsignedlong*pAreaNo);
说明:
获取数据点区域
参数:
TagCount点个数[IN]
pTagNo点序号[IN]
pAreaNo点区域[OUT]
返回值:
数据点的个数
备注:
无
2.3.12CDbComm对象GetTagType方法
语法:
longGetTagType(unsignedlongTagCount,unsignedlong*pTagNo,unsignedlong*pTypeNo);
说明:
获取数据点类型
参数:
TagCount点个数[IN]
pTagNo点序号[IN]
pTypeNo点类型[OUT]
返回值:
数据点的个数
备注:
无
2.3.13CDbComm对象GetDbTagNo方法
语法:
longGetDbTagNo(unsignedlongTagCount,DbTagName*pDbTagName,unsignedlong*pTagNo,unsignedlong*pParNo);
说明:
获取数据点的点序号&参数序号
参数:
TagCount点个数[IN]
pDbTagName数据库点名(点名+参数名)[IN]
pTagNo点序号[OUT]
pParNo点参数序号[OUT]
返回值:
数据点的个数
备注:
DbTagName为数据库点名描述,数据结构定义如下
typedefstruct
{
charName[32];
}DbTagName,*PdbTagName
2.3.14CDbComm对象GetDbTagName方法
语法:
longGetDbTagName(unsignedlongTagCount,unsignedlong*TagNo,unsignedlong*pParNo,DbTagName*pDbTagName);
说明:
获取数据点的名称(点名+参数名)
参数:
TagCount点个数[IN]
TagNo点序号[IN]
pParNo点参数序号[IN]
pDbTagName数据库点名(点名+参数名)[OUT]
返回值:
数据点的个数
备注:
无
2.3.15CDbComm对象GetDbTagType方法
语法:
longGetDbTagType(unsignedlongTagCount,DbTagName*pDbTagName,unsignedlong*pDbTagType);
说明:
获取数据点的类型
参数:
TagCount点个数[IN]
pDbTagName数据库点名(点名+参数名)[IN]
pDbTagType数据库点类型[OUT]
返回值:
数据点的个数
备注:
无
2.4DbComm数据点读写函数
2.4.1CDbComm对象GetData方法
语法:
longGetData(unsignedlongTagCount,unsignedlong*pTagNo,unsignedlong*pParNo,DbTagData*pTagData);
说明:
获取数据点的数据
参数:
TagCount点个数[IN]
pTagNo点序号[IN]
pParNo点参数序号[IN]
pTagData点数据[OUT]
返回值:
数据点的个数
备注:
无
2.4.2CDbComm对象SetData方法
语法:
longSetData(unsignedlongTagCount,unsignedlong*pTagNo,unsignedlong*pParNo,DbTagData*pTagData);
说明:
设置数据点的数据
参数:
TagCount点个数[IN]
pTagNo点序号[IN]
pParNo点参数序号[IN]
pTagData点数据[IN]
返回值:
数据点的个数
备注:
无
备注:
无
2.4.3CDbComm对象GetHisData方法
语法:
longGetHisData(DATEtStartTime,DATEtEndTime,unsignedlongDataCount,unsignedlongTagCount,unsignedlong*pTagNo,unsignedlong*pParNo,double*pHisValue);
说明:
获取数据点的历史数据
参数:
tStartTime开始时间[IN]
tEndTime结束时间[IN]
DataCount历史数据个数[IN]
TagCount点个数[IN]
pTagNo点序号[IN]
pParNo点参数序号[IN]
pHisValue历史数据[OUT]
返回值:
取得的历史数据个数
备注:
无
2.4.4CDbComm对象InsertHisData方法
语法:
longInsertHisData(unsignedlongTagNo,unsignedlongParNo,unsignedlongDataCount,DATE*InsertDate,short*shMilli,double*pHisData);
说明:
插入历史数据
参数:
TagNo点序号[IN]
ParNo点参数序号[IN]
DataCount历史数据个数[IN]
InsertDate插入时间[IN]
shMilli插入毫秒数[IN]
pHisData点数据[IN]
返回值:
插入的历史数据个数
备注:
无
2.5DbComm数据点注册函数
2.5.1CDbComm对象RegTag方法
语法:
longRegTag(unsignedlongTagCount,unsignedlong*pTagNo,unsignedlong*pParNo,unsignedlong*pRegData,unsignedlong*pRegTagNo);
说明:
注册变化通知数据
参数:
TagCount点个数[IN]
pTagNo点序号[IN]
pParNo点参数序号[IN]
pRegData注册点附加数据[IN]
pRegTagNo注册点序号[OUT]
返回值:
注册变化点个数
备注:
无
2.5.2CDbComm对象UnRegTag方法
语法:
longUnRegTag(unsignedlongTagC
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 力控 dbcomm 接口 说明
![提示](https://static.bdocx.com/images/bang_tan.gif)