《系统安装手册范本》由会员分享,可在线阅读,更多相关《系统安装手册范本(34页珍藏版)》请在金锄头文库上搜索。
1、 互联网行情转发服务深圳证券信息有限公司文档编号名 称深证信互联网行情转发系统API接口说明书编写签名: 日期:密级外部公开版本V1.0.0审核签名: 日期:批准深圳证券信息有限公司 版权所有 不得复制目 录1.引言42.安装及应用发布42.1.C语言版本SzsimdApi42.2.Java语言版本SzsimdApi42.3.关于配置的说明53.使用概述53.1.功能53.2.应用环境63.3.线程安全性63.4.应用系统的安全性64.编程参考64.1.常量定义64.1.1.长度常量64.1.2.函数返回值74.2.数据结构说明74.2.1.字段说明74.2.2.STUSzsimdApiSna
2、pshot_XianHuo74.2.3.STUSzsimdApiSnapshot_PanHou84.2.4.STUSzsimdApiSnapshot_ZhiShu84.2.5.STUSzsimdApiSnapshot_HKStk_MDEntry94.2.6.STUSzsimdApiSnapshot_HKStk_ComplexEvent94.2.7.STUSzsimdApiSnapshot_HKStkExt104.2.8.STUSzsimdApiSnapshotMD104.2.9.STUSzsimdApiOneByOneWeiTuo124.2.10.STUSzsimdApiOneByOneChe
3、ngJiao134.2.11.STUSzsimdApiChannelStatisticsPart144.2.12.STUSzsimdApiChannelStatisticsMD144.2.13.STUSzsimdApiStkRtStatusPart154.2.14.STUSzsimdApiStkRtStatusMD154.2.15.STUSzsimdApiMktRtStatusMD164.2.16.STUSzsimdApiNotice174.2.17.STUSzsimdApiCallParam184.3.C函数接口194.3.1.函数清单194.3.2.SzsimdApi_Init194.3.
4、3.SzsimdApi_Run194.3.4.SzsimdApi_Stop204.3.5.SzsimdApi_Destroy204.3.1.SzsimdApi_GetNoticeList214.3.2.调用顺序215.配置文件216.日志文件227.C+编程示例228.Java接口318.1.Java接口编程示例319.注意事项369.1.C语言SzsimdApi线程相关问题369.2.Java语言SzsimdApi线程安全问题36第 34 页 共 34 页1. 引言深圳证券信息有限公司负责深圳证券交易所的基础行情、增强行情的牌照授权工作,目前所有从本公司获得合法行情牌照授权的客户,仅能通过深
5、证通、上证信息、其他信息商等途径获取深交所行情数据,存在着接入成本高、服务不稳定、响应不及时、行情数据延时等种种问题。为保障已授权客户的权益,本公司拟建立深交所基础行情转发平台,为所有已授权基础行情客户提供深交所基础行情数据转发服务。深证信互联网行情转发系统,旨在为各类已授权基础行情客户提供深交所的基础行情数据转发服务,系统建设目标是通过多种服务方式覆盖各类客户群体的行情数据接入需求,提供低成本、低门槛、稳定、高效的行情接入方案。2. 安装及应用发布2.1. C语言版本SzsimdApiC语言版本的SzsimdApi支持的操作系统列表如下:操作系统说明Windows 7Windows7或以上,
6、仅支持64位操作系统Linux CentOS 6.7、RedHat 6.7C语言版本的SzsimdApi由以下几个文件组成:文件名说明szsimdapi.hSzsimdApi头文件szsimdapi.libSzsimdApi库文件szsimdapi.dllSzsimdApi动态链接库文件,Windows平台szsimdapi.iniSzsimdApi配置文件libszsimdapi.soSzsimdApi动态链接库文件,Linux平台2.2. Java语言版本SzsimdApiJava语言版本的SzsimdApi支持的操作系统列表如下:操作系统说明Windows Windows7或以上,仅支持
7、64位操作系统Linux CentOS 6.7、RedHat 6.7Java语言版本的SzsimdApi由以下几个文件组成:文件名说明szsimdapi.jarSzsimdApi jar包szsimdapi.dllSzsimdApi动态链接库文件,Windows平台szsimdapi.iniSzsimdApi配置文件libszsimdapi.soSzsimdApi动态链接库文件,Linux平台2.3. 关于配置的说明SzsimdApi在使用过程中,可以产生运行日志并计入日志文件中。配置文件szsimdapi.ini包含了SzsimdApi日志的产生和输出。文件格式如下:Glob/ 监听的端口,
8、同一个端口只能初始化一次ListenPidPort=1999/ 连接用户网关的设置,其中用户名密码需要用户网关配置文件配置才能正常登陆使用ToAmdUserGw=127.0.0.1:5016:5017:user1:password1SzsimdApiLogType=2/1-循环日志; 2-按照日期每天写一个日志.Level=0/日志级别, 运行时一般取0.Display=3/显示在哪里:1-文件, 2-屏幕, 3-文件和屏幕.LogDir=log/日志目录.LogName=szsimdapi.log/日志文件名称.MaxFileCount=99/最大文件数目,对循环日志有效.MaxFileSi
9、ze=5000000000/最大日志文件大小Byte.3. 使用概述3.1. 功能SzsimdApi是一组提供给用户调用的C/Java语言应用程序接口,用户可以调用该API开发,实现深证信互联网行情的接收,SzsimdApi可以完成通信的自动连接,接收数据包,数据压缩解压等功能,应用程序只需要设置好对应的回调函数就可以接收深交所二进制行情数据,API处于最底层,由应用程序调用,通过TCP连接与上层节点通信。将接收到的数据包处理后,通过回调接口通知给调用的应用程序。3.2. 应用环境图1 SZSIMD API应用环境在深证信互联网行情转发系统中,SZSIMD用户网关负责接收SZSIMD行情转发节
10、点推送的行情数据,SZSIMD API通过直接连接SZSIMD用户网关获取行情数据。3.3. 线程安全性参看下面4.3节。3.4. 应用系统的安全性用户在应用软件中调用了 SzsimdApi, 在 SzsimdApi 中不会包含故意攻击用户系统的软件或代码,不会故意影响用户系统的安全运行。用户系统自身的安全性,应该由用户自己进行检查和维护,SzsimdApi 无法保证用户系统本身的安全性。4. 编程参考4.1. 常量定义4.1.1. 长度常量名称定义值说明G_SZSIMDAPI_MAXLEN_ERRORSTR256错误码字符串的最大长度4.1.2. 函数返回值返回值含义0成功-1失败4.2.
11、数据结构说明4.2.1. 字段说明类型说明const char*以0字符结尾的字符串(U)INT(8/16/32/64)(无符号)整数(8/16/32/64位)4.2.2. STUSzsimdApiSnapshot_XianHuo该结构用来定义现货(股票,基金,债券等)集中竞价交易快照行情数据结构定义:struct STUSzsimdApiSnapshot_XianHuoconst char*m_psMDEntryType;INT64m_i64MDEntryPx;INT64m_i64MDEntrySize;UINT16m_ui16MDPriceLevel;INT64m_i64NumberOfO
12、rders;UINT32m_ui32NoOrders;INT64*m_pArrayOrderQty;字段说明:字段说明m_psMDEntryType行情条目类别m_i64MDEntryPx价格m_i64MDEntrySize数量m_ui16MDPriceLevel买卖盘档位m_i64NumberOfOrders价位总委托笔数,为0表示不揭示m_ui32NoOrders价位揭示委托笔试,为0表示不揭示m_pArrayOrderQty委托数量数组字段具体含义和格式定义等明细参见深圳证券交易所Binary行情数据接口规规范。4.2.3. STUSzsimdApiSnapshot_PanHou该结构用
13、来定义盘后定价交易业务行情快照数据结构定义:struct STUSzsimdApiSnapshot_PanHouconst char*m_psMDEntryType;INT64m_i64MDEntryPx;INT64m_i64MDEntrySize;字段说明:字段说明m_psMDEntryType行情条目类别,0=买入,1=卖出m_i64MDEntryPx价格m_i64MDEntrySize数量字段具体含义和格式定义等明细参见深圳证券交易所Binary行情数据接口规规范。4.2.4. STUSzsimdApiSnapshot_ZhiShu该结构用来定义指数行情快照数据结构定义:struct S
14、TUSzsimdApiSnapshot_ZhiShuconst char*m_psMDEntryType;INT64m_i64MDEntryPx;字段说明:字段说明m_psMDEntryType行情条目类别m_i64MDEntryPx指数点位字段具体含义和格式定义等明细参见深圳证券交易所Binary行情数据接口规规范。4.2.5. STUSzsimdApiSnapshot_HKStk_MDEntry该结构用来定义港股行情快照扩展字段的行情条目结构定义:struct STUSzsimdApiSnapshot_HKStk_MDEntryconst char*m_psMDEntryType;INT64m_i64MDEntryPx;INT