| Xlight API用户手册 v1.6.0.23 Xlight极速柜台接口文档

载入中...
搜索中...
未找到
特权API

# 特权API简介

特权API用于xlight内部系统开发所用，交易用户严禁调用。

相关头文件：

- `xlt_api/xlt_privilege/xlt_privilege_api.h`
- `xlt_api/xlt_privilege/xlt_privilege_config.h`
- `xlt_api/xlt_privilege/xlt_privilege_struct.h`
- `xlt_api/xlt_privilege/xlt_privilege_list.h`

特权API由以下三个核心部分组成：

组成 | 类 | 说明
--- | --- | ---
配置 | XLTPrivilegeConfig | 继承自 XLTTradeConfig，可复用交易API的全部配置项
接口 | XLTPrivilege | 特权API入口类（管理接口），继承自 XLTTradeApi，同时具备交易API能力并扩展特权相关接口
回调 | XLTPrivilegeSpi | 特权回调接口，继承自 XLTTradeSpi，额外提供 token/行情登录信息推送、导出文件响应、解绑响应、简要查询响应等

可从以下入口查看接口与数据结构的完整定义：

- 文件列表（定位 `xlt_privilege_api.h`）
- 类列表

## 配置说明（XLTPrivilegeConfig）

`XLTPrivilegeConfig` 继承自 XLTTradeConfig，可直接复用交易API的全部配置项。

配置项 | 接口 | 说明 | 配置样例
--- | --- | --- | ---
交易日 | x1::XLTTradeConfig::set_trading_day | 格式YYYYMMDD；生产环境通常为当前交易日 | `config.set_trading_day(20260402);`
本地网卡IP | x1::XLTTradeConfig::set_local_addr | 设置连接AGW与交易的本地网卡IP | `config.set_local_addr("192.168.8.155", "192.168.2.155");`
AGW地址 | x1::XLTTradeConfig::add_agw_addr | 添加一个AGW地址（可重复添加多个） | `config.add_agw_addr("192.168.5.64", 7060);`
订单超时 | x1::XLTTradeConfig::set_order_timeout | 单位秒；超时触发 x1::XLTTradeSpi::on_order_timeout | `config.set_order_timeout(10);`
自定义订单序号 | x1::XLTTradeConfig::set_order_seq_self_define | 启用后下单/撤单需填写 order_sequence 且需保证唯一 | `config.set_order_seq_self_define(true);`

以下为进程级环境变量配置，通过系统环境变量设置。若同一进程中同时使用了交易API和行情API，则共用同一份环境变量。

环境变量 | 默认值 | 说明 | 配置样例
--- | --- | --- | ---
XLT_FILE_PATH | `.`（当前路径） | 文件存放路径（如日志文件）。若路径不存在，API将无法初始化 | `export XLT_FILE_PATH=/data/xlt`
XLT_LOG_LEVEL | INFO | 日志级别，可选值：FATAL / ERROR / WARN / INFO / DEBUG / TRACE | `export XLT_LOG_LEVEL=DEBUG`
XLT_REQUEST_TIMEOUT | 5 | 请求超时时间，单位秒 | `export XLT_REQUEST_TIMEOUT=10`

## 接口说明（XLTPrivilege）

分类 | 接口 | 说明
--- | --- | ---
初始化 | x1::XLTPrivilege::initialize |
停止 | x1::XLTPrivilege::stop | 停止回调，退出程序前调用，避免回调线程访问已销毁的对象
登录 | x1::XLTPrivilege::login |
导出 | x1::XLTPrivilege::dump_final_file |
解绑 | x1::XLTPrivilege::unbind_user_tgw |
资金划拨（执行层） | x1::XLTPrivilege::insert_fund_transfer_exec |
资金划拨（主柜） | x1::XLTPrivilege::submit_counter_fund_transfer_request |
| x1::XLTPrivilege::submit_counter_fund_transfer_result |
资金划拨（双中心） | x1::XLTPrivilege::submit_cluster_fund_transfer_request |
| x1::XLTPrivilege::submit_cluster_fund_transfer_result |
查询 | x1::XLTPrivilege::query_brief_assets |
| x1::XLTPrivilege::query_brief_positions |

提示：由于 XLTPrivilege 继承自 XLTTradeApi，你也可以直接复用交易API的"订阅/下单/撤单/查询"等能力。

## 回调说明（XLTPrivilegeSpi）

类别 | 回调接口 | 说明
--- | --- | ---
推送 | x1::XLTPrivilegeSpi::on_token |
| x1::XLTPrivilegeSpi::on_quote_login_info |
| x1::XLTTradeSpi::on_fund_transfer_exec_result |
导出/解绑 | x1::XLTPrivilegeSpi::on_dump_final_file |
| x1::XLTPrivilegeSpi::on_unbind_user_tgw |
简要查询 | x1::XLTPrivilegeSpi::on_query_brief_assets |
| x1::XLTPrivilegeSpi::on_query_brief_positions |

提示：由于 XLTPrivilegeSpi 继承自 XLTTradeSpi，交易API的所有回调同样适用。