管理接口类更多...

#include <xlt_privilege_api.h>

类 x1::XLTPrivilege 继承关系图:

Public 成员函数
bool	initialize (XLTPrivilegeConfig config, XLTPrivilegeSpi spi)
	初始化API，登录之前必须调用此函数，只能初始化一次

void	stop ()
	停止特权API 断开所有特权session连接，清空所有session上的回调指针，停止回调。

bool	login (uint64_t request_id, const char account_name, const char password, const char *pub_key)
	用户登录请求

bool	dump_final_file (uint64_t session_id, uint64_t request_id)
	导出下场文件

bool	unbind_user_tgw (uint64_t session_id, uint64_t request_id, uint64_t account_index)
	解绑用户与交易网关的绑定关系

bool	insert_fund_transfer_exec (uint64_t session_id, uint64_t request_id, const xlt_fund_transfer_exec_request_t *fund_transfer_exec_req)
	插入资金划转执行请求

bool	submit_counter_fund_transfer_request (uint64_t session_id, uint64_t request_id, const xlt_counter_fund_transfer_request_t *fund_transfer_request)
	提交资金划转请求

bool	submit_counter_fund_transfer_result (uint64_t session_id, uint64_t request_id, const xlt_counter_fund_transfer_result_t *fund_transfer_result)
	提交资金划转结果

bool	submit_cluster_fund_transfer_request (uint64_t session_id, uint64_t request_id, const xlt_cluster_fund_transfer_request_t *cluster_fund_transfer_request)
	提交双中心资金划转请求

bool	submit_cluster_fund_transfer_result (uint64_t session_id, uint64_t request_id, const xlt_cluster_fund_transfer_result_t *cluster_fund_transfer_result)
	提交双中心资金划转结果

bool	query_brief_assets (uint64_t session_id, uint64_t request_id, uint64_t account_index=0)
	请求查询简要资产信息

bool	query_brief_positions (uint64_t session_id, uint64_t request_id, const char *security_code, ExchangeIndex exchange_index, uint64_t account_index=0)
	请求查询简要持仓信息

Public 成员函数继承自 x1::XLTTradeApi
bool	initialize (XLTTradeConfig trade_config, XLTTradeSpi trade_spi)
	初始化交易，登录之前必须调用此函数，只能初始化一次

void	stop ()
	停止交易API 断开所有交易session连接，清空所有session上的回调指针，停止回调。

bool	login (uint64_t request_id, uint16_t client_id, const char account_name, const char password, const char pub_key, const xlt_user_terminal_info_t info=nullptr)
	用户登录请求

bool	logout (uint64_t session_id)
	登出请求

bool	auth_trade (uint64_t session_id, uint64_t request_id, const char account_name, const char password, const char pub_key, const xlt_user_terminal_info_t info=nullptr)
	交易授权认证

bool	deauth_trade (uint64_t session_id, uint64_t request_id, uint64_t trade_token)
	解除交易授权认证

uint32_t	get_trading_day ()
	获取当前交易日。只有登录成功后,才能得到正确的交易日。

const xlt_init_asset_info_t *	get_init_assets (uint64_t session_id, uint64_t trade_token=0)
	获取初始资产信息

const XLTInitPositionList *	get_init_positions (uint64_t session_id, uint64_t trade_token=0)
	获取初始持仓信息

uint64_t	get_account_index (uint64_t session_id, uint64_t trade_token=0)
	获取账户索引，只有登录成功后，才能得到正确的资金账户索引

void	get_xid_sender (uint64_t xid, uint64_t &session_id, uint64_t &trade_token)
	根据订单ID获取订单发送者信息，包括session_id和trade_token

void	get_biz_sender (char *biz_no, uint64_t &session_id, uint64_t &trade_token)
	根据业务编号获取发送者信息，包括session_id和trade_token

bool	subscribe_trade_message (uint64_t session_id, uint64_t request_id, trade_message_type_t trade_message_type, TradeResumeType resume_type, uint64_t start_sequence)
	订阅交易数据每个session_id，仅第一次调用有效。

bool	rebuild_trade_message (uint64_t session_id, uint64_t request_id, trade_message_type_t trade_message_type, uint64_t start_sequence, uint64_t end_sequence, uint64_t account_index=0)
	重推消息

void	init_local_send ()
	本地发送初始化函数，预分配本地发送资源，非必须调用。若不调用，会在首次发送订单时自动进行初始化，故建议在用户线程调用发送接口前调用此函数以避免首次发送订单时的延迟。

uint64_t	insert_order (uint64_t session_id, xlt_order_insert_info_t *order, uint64_t trade_token=0)
	委托报单录入请求，所有业务统一报单接口，根据业务类型字段区分不同业务。 Xlight接收订单后，会在报单响应函数on_order_response, on_cancel_response, on_order_error_response中返回, 之后所有的成交明细会在on_trade_report中返回，当订单到达终止状态会触发订单状态结束响应。

uint64_t	cancel_order (uint64_t session_id, xlt_cancel_order_info_t *cancel_order, uint64_t trade_token=0)
	撤单撤单请求。如果撤单成功，会在报单响应函数on_cancel_response里返回原单部撤或者全撤的消息，如果不成功，会在on_order_error_response响应函数中返回错误原因。

bool	resend_order_request (uint64_t session_id, uint64_t xid)
	重发订单请求

bool	submit_counter_fund_transfer_request (uint64_t session_id, uint64_t request_id, FundTransSide side, amount_t amount, char *biz_no=nullptr, uint64_t trade_token=0)
	提交主柜资金划转请求

bool	submit_cluster_fund_transfer_request (uint64_t session_id, uint64_t request_id, amount_t amount, char *biz_no=nullptr, uint64_t trade_token=0)
	提交双中心资金划转请求，方向固定为划入

bool	query_assets (uint64_t session_id, uint64_t request_id, uint64_t account_index=0)
	请求查询资产

bool	query_positions (uint64_t session_id, uint64_t request_id, const char *security_code, ExchangeIndex exchange_index=ExchangeIndex::INIT, uint64_t account_index=0)
	请求查询投资者持仓

bool	query_orders (uint64_t session_id, uint64_t request_id, const xlt_order_query_param_t *order_query_param, uint64_t account_index=0)
	请求查询订单

bool	query_orders_by_page (uint64_t session_id, uint64_t request_id, uint32_t request_count, const xlt_page_query_reference_t *query_reference, uint64_t account_index=0)
	分页请求查询报单

bool	query_trades (uint64_t session_id, uint64_t request_id, uint64_t xid, uint64_t account_index=0)
	请求查询成交回报

bool	query_init_assets (uint64_t session_id, uint64_t request_id, uint64_t account_index=0)
	请求查询初始资产

bool	query_init_positions (uint64_t session_id, uint64_t request_id, const char *security_code, ExchangeIndex exchange_index, uint64_t account_index=0)
	请求查询初始持仓

bool	query_trade_account_info (uint64_t session_id, uint64_t request_id, uint64_t account_index=0)
	请求查询交易账户信息

bool	dump_api_performance_info ()

静态 Public 成员函数
static XLTPrivilege *	create ()
	创建实例（只能创建一次）

static uint64_t	xid_to_token_id (uint64_t xid)
	根据订单ID获取token_id

静态 Public 成员函数继承自 x1::XLTTradeApi
static XLTTradeApi *	create ()
	创建实例（只能创建一次）

static const char *	get_api_version ()
	获取API版本号

static xlt_error_info_t	get_last_error ()
	获取错误信息

static uint64_t	get_order_sequence (uint64_t xid)
	根据订单ID获取订单序列号

额外继承的成员函数
Protected 成员函数继承自 x1::XLTTradeApi
	XLTTradeApi ()=default

详细描述

管理接口类

成员函数说明

◆ create()

static XLTPrivilege * x1::XLTPrivilege::create ( )

static

创建实例（只能创建一次）

返回: 返回管理接口实例

◆ dump_final_file()

bool x1::XLTPrivilege::dump_final_file	(	uint64_t	session_id,
		uint64_t	request_id )

导出下场文件

参数

session_id	会话id，登录时得到
request_id	用于用户定位查询响应的ID，由用户自定义

返回: 请求发送是否成功，true表示成功，false表示出错，此时用户可以调用get_last_error()来获取错误代码

◆ initialize()

bool x1::XLTPrivilege::initialize	(	XLTPrivilegeConfig *	config,
		XLTPrivilegeSpi *	spi )

初始化API，登录之前必须调用此函数，只能初始化一次

参数

config	配置信息
spi	回调接口

返回: 初始化是否成功

◆ insert_fund_transfer_exec()

bool x1::XLTPrivilege::insert_fund_transfer_exec	(	uint64_t	session_id,
		uint64_t	request_id,
		const xlt_fund_transfer_exec_request_t *	fund_transfer_exec_req )

插入资金划转执行请求

参数

session_id	会话id，登录时得到
request_id	用于用户定位响应的ID，由用户自定义
fund_transfer_exec_req	资金划转执行请求信息

返回: 请求发送是否成功，true表示成功，false表示出错，此时用户可以调用get_last_error()来获取错误代码

◆ login()

bool x1::XLTPrivilege::login	(	uint64_t	request_id,
		const char *	account_name,
		const char *	password,
		const char *	pub_key )

用户登录请求

参数

request_id	用于用户定位请求响应的ID，由用户自定义
account_name	交易账号
password	登录密码
pub_key	用户公钥(长度64字节)，系统分发

返回: 查询请求发送是否成功，若失败时用户可以调用get_last_error()来获取错误信息。

◆ query_brief_assets()

bool x1::XLTPrivilege::query_brief_assets	(	uint64_t	session_id,
		uint64_t	request_id,
		uint64_t	account_index = 0 )

请求查询简要资产信息

参数

session_id	会话id，登录时得到
request_id	用于用户定位查询响应的ID，由用户自定义
account_index	交易账号索引

返回: 请求发送是否成功，true表示成功，false表示出错，此时用户可以调用get_last_error()来获取错误信息。

◆ query_brief_positions()

bool x1::XLTPrivilege::query_brief_positions	(	uint64_t	session_id,
		uint64_t	request_id,
		const char *	security_code,
		ExchangeIndex	exchange_index,
		uint64_t	account_index = 0 )

请求查询简要持仓信息

参数

session_id	会话id，登录时得到
request_id	用于用户定位查询响应的ID，由用户自定义
security_code	需要查询持仓的合约代码，可以为空表示查询全市场，如果不为空，请不带空格，并以'\0'结尾
exchange_index	需要查询持仓的合约所在市场，默认为INIT。如果想正确查询指定持仓，请指定exchange_index
account_index	交易账号索引

返回: 请求发送是否成功，true表示成功，false表示出错，此时用户可以调用get_last_error()来获取错误信息。

备注: 该方法如果用户提供了合约代码，则会查询此合约的持仓信息，如果合约代码为空，则默认查询所有持仓信息。

◆ stop()

void x1::XLTPrivilege::stop ( )

停止特权API 断开所有特权session连接，清空所有session上的回调指针，停止回调。

备注: 调用stop后，所有未完成的回调将不再触发，用户可安全地释放对象。

◆ submit_cluster_fund_transfer_request()

bool x1::XLTPrivilege::submit_cluster_fund_transfer_request	(	uint64_t	session_id,
		uint64_t	request_id,
		const xlt_cluster_fund_transfer_request_t *	cluster_fund_transfer_request )

提交双中心资金划转请求

参数

session_id	会话id，登录时得到
request_id	用于用户定位响应的ID，由用户自定义
cluster_fund_transfer_request	双中心资金划转请求信息

返回: 请求发送是否成功，true表示成功，false表示出错，此时用户可以调用get_last_error()来获取错误代码

◆ submit_cluster_fund_transfer_result()

bool x1::XLTPrivilege::submit_cluster_fund_transfer_result	(	uint64_t	session_id,
		uint64_t	request_id,
		const xlt_cluster_fund_transfer_result_t *	cluster_fund_transfer_result )

提交双中心资金划转结果

参数

session_id	会话id，登录时得到
request_id	用于用户定位响应的ID，由用户自定义
cluster_fund_transfer_result	双中心资金划转结果信息

返回: 请求发送是否成功，true表示成功，false表示出错，此时用户可以调用get_last_error()来获取错误代码

◆ submit_counter_fund_transfer_request()

bool x1::XLTPrivilege::submit_counter_fund_transfer_request	(	uint64_t	session_id,
		uint64_t	request_id,
		const xlt_counter_fund_transfer_request_t *	fund_transfer_request )

提交资金划转请求

参数

session_id	会话id，登录时得到
request_id	用于用户定位响应的ID，由用户自定义
fund_transfer_request	资金划转请求信息

返回: 请求发送是否成功，true表示成功，false表示出错，此时用户可以调用get_last_error()来获取错误代码

◆ submit_counter_fund_transfer_result()

bool x1::XLTPrivilege::submit_counter_fund_transfer_result	(	uint64_t	session_id,
		uint64_t	request_id,
		const xlt_counter_fund_transfer_result_t *	fund_transfer_result )

提交资金划转结果

参数

session_id	会话id，登录时得到
request_id	用于用户定位响应的ID，由用户自定义
fund_transfer_result	资金划转结果信息

返回: 请求发送是否成功，true表示成功，false表示出错，此时用户可以调用get_last_error()来获取错误代码

◆ unbind_user_tgw()

bool x1::XLTPrivilege::unbind_user_tgw	(	uint64_t	session_id,
		uint64_t	request_id,
		uint64_t	account_index )

解绑用户与交易网关的绑定关系

参数

session_id	会话id，登录时得到
request_id	用于用户定位查询响应的ID，由用户自定义
account_index	账号索引

返回: 请求发送是否成功，true表示成功，false表示出错，此时用户可以调用get_last_error()来获取错误代码

◆ xid_to_token_id()

static uint64_t x1::XLTPrivilege::xid_to_token_id ( uint64_t xid )

static

根据订单ID获取token_id

参数

xid

返回: token_id

该类的文档由以下文件生成:

xlt_privilege_api.h

Public 成员函数

静态 Public 成员函数

额外继承的成员函数

详细描述

成员函数说明

◆ create()

◆ dump_final_file()

◆ initialize()

◆ insert_fund_transfer_exec()

◆ login()

◆ query_brief_assets()

◆ query_brief_positions()

◆ stop()

◆ submit_cluster_fund_transfer_request()

◆ submit_cluster_fund_transfer_result()

◆ submit_counter_fund_transfer_request()

◆ submit_counter_fund_transfer_result()

◆ unbind_user_tgw()

◆ xid_to_token_id()