华锐交易执行平台标准网关API使用说明

发布于 2018-11-16 作者 luojian345 581次 浏览 版块 ATP-华锐核心交易平台

华锐交易执行平台标准网关API使用说明

文档目的

本文档是华锐金融技术股份有限公司ATP平台agw模块的api使用说明。

术语与缩略语

术语、缩写 解释
ATP 华锐交易执行平台
AGW 华锐标准网关

参考文档

  • 《可扩展二进制数据交换协议_0.10.docx》
  • 《华锐ATP交易数据接口协议_0.10.docx》

API说明

本api是连接华锐标准网关的API客户端,使用C++编写,运行环境为redhat7.2、boost_1_62_0,编译器为gcc 4.8.5。
windows 编译运行环境为windows7 64位, 使用visual studio 2017 编译。

调用api主要直接使用到以下几个头文件:

文件名 说明
agw_client.h AgwClient接口的定义和说明
agw_event.h 错误码以及回调接口的说明
messages_agw_external.h 业务消息的定义

AgwClient接口函数说明

Connect函数

项目 说明
函数声明 ErrorCode Connect(const Properties& properties,ClientHandler* handler)
函数说明 发起异步连接AGW
返回值 0[kSuccess]为成功,其他为失败
参数说明 properties[in] 连接参数设置
handler[in] 事件回调处理句柄,继承自agw::ClientHandler

properties 可以设置的参数有:

  • “User”: string,登录的用户名,必填
  • “PasswordSha256”:string 登录的密码,sha256散列后的密码,必填
  • “Locations”: 连接地址,vector,每个连接地址为”ip:port”形式,必填
  • “HeartbeatIntervalMilli”: 发心跳间隔时间,int32_t,单位:毫秒,默认值:5000
  • “HeartbeatTimeoutMilli”: 检测心跳超时时间,int32_t,单位:毫秒,默认值:HeartbeatInterval*3
  • “ConnectTimeoutMilli”: 连接超时时间,int32_t,单位:毫秒,默认值:5000
  • “ReconnectTime”: 重试连接次数,int32_t,默认值:连接地址数
  • “ReconnectDelayMilli”:重新连接延迟时间,