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

载入中...
搜索中...
未找到
Public 成员函数
XLTTradeSpi类 参考

交易回调类 更多...

`#include <xlt_api.h>`

## Public 成员函数
virtual void | on_disconnect (uint64_t session_id)
| 断线通知 用户断线之后需要重新调用login方法，建立连接并登录
virtual void | on_login (uint64_t session_id, uint64_t request_id, xlt_error_info_t *error_info)
| 登录通知
virtual void | on_order_end (uint64_t session_id, xlt_order_end_t *order_end)
| 订单结束通知
virtual void | on_order_response (uint64_t session_id, xlt_order_response_t *order_response)
| 新订单申报成功响应
virtual void | on_cancel_response (uint64_t session_id, xlt_cancel_response_t *cancel_response)
| 撤单成功响应
virtual void | on_trade_report (uint64_t session_id, xlt_trade_report_t *trade_report)
| 成交回报通知
virtual void | on_order_error_response (uint64_t session_id, xlt_order_error_response_t *order_error_response)
| 委托失败通知
virtual void | on_raw_report (uint64_t session_id, uint8_t client_id, uint64_t xid, char report_id[32], uint64_t sequence, ExchangeIndex exchange_index, uint32_t report_size, char *raw_report)
| 交易所原始订单执行报告（需用户自行解码）
virtual void | on_query_positions (uint64_t session_id, uint64_t request_id, xlt_position_info_t positions[], uint32_t data_count, bool is_last, xlt_error_info_t *error_info)
| 持仓查询响应
virtual void | on_query_assets (uint64_t session_id, uint64_t request_id, xlt_asset_info_t assets[], uint32_t data_count, bool is_last, xlt_error_info_t *error_info)
| 资金查询响应
virtual void | on_query_orders (uint64_t session_id, uint64_t request_id, xlt_order_info_t order_infos[], uint32_t data_count, bool is_last, xlt_error_info_t *error_info)
| 订单查询响应
virtual void | on_query_orders_by_page (uint64_t session_id, uint64_t request_id, xlt_order_info_t order_infos[], uint64_t data_count, uint64_t req_count, uint64_t rsp_count, uint64_t query_reference, bool is_last, xlt_error_info_t *error_info)
| 分页请求查询报单响应
virtual void | on_query_trades (uint64_t session_id, uint64_t request_id, xlt_trade_report_t trade_reports[], uint32_t data_count, bool is_last, xlt_error_info_t *error_info)
| 成交回报查询响应
virtual void | on_query_static_quote_info (uint64_t session_id, uint64_t request_id, xlt_static_quote_full_info_t static_quote_full_infos[], uint32_t data_count, bool is_last, xlt_error_info_t *error_info)
| 查询全量静态行情信息响应
virtual void | on_query_sse_l1_index (uint64_t session_id, uint64_t request_id, sse_l1_index_t *sse_l1_index, xlt_error_info_t *error_info)
| 查询最新上交所level1指数行情响应
virtual void | on_query_sse_l1_snapshot (uint64_t session_id, uint64_t request_id, sse_l1_snapshot_t *sse_l1_snapshot, xlt_error_info_t *error_info)
| 查询最新上交所level1快照行情响应
virtual void | on_query_szse_l1_index (uint64_t session_id, uint64_t request_id, szse_l1_index_t *szse_l1_index, xlt_error_info_t *error_info)
| 查询最新深交所level1指数行情响应
virtual void | on_query_szse_l1_snapshot (uint64_t session_id, uint64_t request_id, szse_l1_snapshot_t *szse_l1_snapshot, xlt_error_info_t *error_info)
| 查询最新深交所level1快照行情响应
virtual void | on_query_szse_l1_snapshot_bond (uint64_t session_id, uint64_t request_id, szse_l1_snapshot_bond_t *szse_l1_snapshot_bond, xlt_error_info_t *error_info)
| 查询最新深交所level1债券快照行情响应
virtual void | on_request_timeout (uint64_t session_id, uint64_t request_id)
| 查询超时通知
virtual void | on_order_timeout (uint64_t session_id, uint64_t xid)
| 订单超时通知

## 详细描述

交易回调类

## 成员函数说明

## ◆ on_cancel_response()

virtual void on_cancel_response | ( | uint64_t | session_id,
|  | xlt_cancel_response_t * | cancel_response )
| inline virtual

撤单成功响应

此函数用于处理来自交易系统的撤单成功响应。

参数

  session_id | 会话ID。
  cancel_response | 撤单成功响应数据指针。

## ◆ on_disconnect()

virtual void on_disconnect | ( | uint64_t | session_id | ) |
| inline virtual

断线通知 用户断线之后需要重新调用login方法，建立连接并登录

参数

  session_id | 会话ID。

## ◆ on_login()

virtual void on_login | ( | uint64_t | session_id,
|  | uint64_t | request_id,
|  | xlt_error_info_t * | error_info )
| inline virtual

登录通知

参数

  session_id | 本次登录生成的会话ID。如果登录失败则为0。
  request_id | 此消息响应函数对应的请求ID
  error_info | 登录请求发生错误时返回的错误信息，当error_info为空，或者error_info.error_id为0时，表明没有错误。

## ◆ on_order_end()

virtual void on_order_end | ( | uint64_t | session_id,
|  | xlt_order_end_t * | order_end )
| inline virtual

订单结束通知

本函数用于接收订单结束通知；当订单状态变为完全成交、撤单成功、废单等终结状态时，交易系统会发送该通知。

参数

  session_id | 会话ID。
  order_end | 包含订单结束信息的数据指针。

## ◆ on_order_error_response()

virtual void on_order_error_response | ( | uint64_t | session_id,
|  | xlt_order_error_response_t * | order_error_response )
| inline virtual

委托失败通知

此函数用于处理来自交易系统的委托失败通知。 包括内部拒单、交易所拒单、废单及撤单失败等情况。

参数

  session_id | 会话ID。
  order_error_response | 委托失败通知数据指针。

## ◆ on_order_response()

virtual void on_order_response | ( | uint64_t | session_id,
|  | xlt_order_response_t * | order_response )
| inline virtual

新订单申报成功响应

此函数用于处理来自交易系统的申报成功响应。

参数

  session_id | 会话ID。
  order_response | 申报成功响应数据指针。

## ◆ on_order_timeout()

virtual void on_order_timeout | ( | uint64_t | session_id,
|  | uint64_t | xid )
| inline virtual

订单超时通知

参数

  session_id | 会话id，登录时得到
  xid | 超时的订单标识

备注
  订单超时通知是指在指定时间内未收到订单的成交回报或状态更新时触发的通知，不代表委托失败，需要用户自行查询确认订单状态。

## ◆ on_query_assets()

virtual void on_query_assets | ( | uint64_t | session_id,
|  | uint64_t | request_id,
|  | xlt_asset_info_t | assets[],
|  | uint32_t | data_count,
|  | bool | is_last,
|  | xlt_error_info_t * | error_info )
| inline virtual

资金查询响应

参数

  session_id | 会话id，登录时得到
  request_id | 此消息响应函数对应的请求ID
  assets | 查询到的资金账户列表情况，个数由data_count决定
  data_count | 本次响应返回的资金个数
  is_last | 此消息响应函数是否为request_id这条请求所对应的最后一个响应，当为最后一个的时候为true，如果为false，表示还有其他后续消息响应
  error_info | 查询资金账户发生错误时返回的错误信息，当error_info为空，或者error_info.error_id为0时，表明没有错误

备注
  需要快速返回，否则会堵塞后续消息，当堵塞严重时，会触发断线

## ◆ on_query_orders()

virtual void on_query_orders | ( | uint64_t | session_id,
|  | uint64_t | request_id,
|  | xlt_order_info_t | order_infos[],
|  | uint32_t | data_count,
|  | bool | is_last,
|  | xlt_error_info_t * | error_info )
| inline virtual

订单查询响应

参数

  session_id | 会话id，登录时得到
  request_id | 此消息响应函数对应的请求ID
  order_infos | 本次响应返回的订单信息，个数由data_count决定
  data_count | 本次响应返回的数据条数
  is_last | 此消息响应函数是否为request_id这条请求所对应的最后一个响应，当为最后一个的时候为true，如果为false，表示还有其他后续消息响应
  error_info | 查询订单时发生错误时，返回的错误信息，当error_info为空，或者error_info.error_id为0时，表明没有错误

备注
  需要快速返回，否则会堵塞后续消息，当堵塞严重时，会触发断线

## ◆ on_query_orders_by_page()

virtual void on_query_orders_by_page | ( | uint64_t | session_id,
|  | uint64_t | request_id,
|  | xlt_order_info_t | order_infos[],
|  | uint64_t | data_count,
|  | uint64_t | req_count,
|  | uint64_t | rsp_count,
|  | uint64_t | query_reference,
|  | bool | is_last,
|  | xlt_error_info_t * | error_info )
| inline virtual

分页请求查询报单响应

参数

  session_id | 会话id，登录时得到
  request_id | 此消息响应函数对应的请求ID
  order_infos | 查询到的一个报单
  data_count | 本次响应返回的数据条数
  req_count | 分页请求的最大数量
  rsp_count | 分页请求的当前回报数量
  query_reference | 当前报单信息所对应的查询索引，需要记录下来，在进行下一次分页查询的时候需要用到
  is_last | 此消息响应函数是否为request_id这条请求所对应的最后一个响应，当为最后一个的时候为true，如果为false，表示还有其他后续消息响应
  error_info | 查询报单时发生错误时，返回的错误信息，当error_info为空，或者error_info.error_id为0时，表明没有错误

备注
  当order_sequence为0，表明当次查询没有查到任何记录，当is_last为true时，如果order_sequence等于req_count，那么表示还有报单，可以进行下一次分页查询，如果不等，表示所有报单已经查询完毕。一个查询请求可能对应多个响应，需要快速返回，否则会堵塞后续消息，当堵塞严重时，会触发断线。

## ◆ on_query_positions()

virtual void on_query_positions | ( | uint64_t | session_id,
|  | uint64_t | request_id,
|  | xlt_position_info_t | positions[],
|  | uint32_t | data_count,
|  | bool | is_last,
|  | xlt_error_info_t * | error_info )
| inline virtual

持仓查询响应

参数

  session_id | 会话id，登录时得到
  request_id | 此消息响应函数对应的请求ID
  positions | 本次响应返回的持仓列表，个数由data_count决定
  data_count | 本次响应返回的持仓个数
  is_last | 此消息响应函数是否为request_id这条请求所对应的最后一个响应，当为最后一个的时候为true，如果为false，表示还有其他后续消息响应
  error_info | 查询账户持仓发生错误时返回的错误信息，当error_info为空，或者error_info.error_id为0时，表明没有错误

备注
  一个查询请求可能对应多个响应，需要快速返回，否则会堵塞后续消息，当堵塞严重时，会触发断线

## ◆ on_query_sse_l1_index()

virtual void on_query_sse_l1_index | ( | uint64_t | session_id,
|  | uint64_t | request_id,
|  | sse_l1_index_t * | sse_l1_index,
|  | xlt_error_info_t * | error_info )
| inline virtual

查询最新上交所level1指数行情响应

参数

  session_id | 会话id，登录时得到
  request_id | 请求ID
  sse_l1_index | 上交所L1指数行情快照
  error_info | 查询发生错误时返回的错误信息，当error_info为空，或者error_info.error_id为0时，表明没有错误

## ◆ on_query_sse_l1_snapshot()

virtual void on_query_sse_l1_snapshot | ( | uint64_t | session_id,
|  | uint64_t | request_id,
|  | sse_l1_snapshot_t * | sse_l1_snapshot,
|  | xlt_error_info_t * | error_info )
| inline virtual

查询最新上交所level1快照行情响应

参数

  session_id | 会话id，登录时得到
  request_id | 请求ID
  sse_l1_snapshot | 上交所L1快照行情
  error_info | 查询发生错误时返回的错误信息，当error_info为空，或者error_info.error_id为0时，表明没有错误

## ◆ on_query_static_quote_info()

virtual void on_query_static_quote_info | ( | uint64_t | session_id,
|  | uint64_t | request_id,
|  | xlt_static_quote_full_info_t | static_quote_full_infos[],
|  | uint32_t | data_count,
|  | bool | is_last,
|  | xlt_error_info_t * | error_info )
| inline virtual

查询全量静态行情信息响应

参数

  session_id | 会话id，登录时得到
  request_id | 请求ID
  static_quote_full_infos | 本次响应返回的全量静态行情信息列表，个数由data_count决定
  data_count | 本次响应返回的数据个数
  is_last | 此消息响应函数是否为request_id这条请求所对应的最后一个响应，当为最后一个的时候为true，如果为false，表示还有其他后续消息响应
  error_info | 查询发生错误时返回的错误信息，当error_info为空，或者error_info.error_id为0时，表明没有错误

备注
  一个查询请求可能对应多个响应，需要快速返回，否则会堵塞后续消息，当堵塞严重时，会触发断线

## ◆ on_query_szse_l1_index()

virtual void on_query_szse_l1_index | ( | uint64_t | session_id,
|  | uint64_t | request_id,
|  | szse_l1_index_t * | szse_l1_index,
|  | xlt_error_info_t * | error_info )
| inline virtual

查询最新深交所level1指数行情响应

参数

  session_id | 会话id，登录时得到
  request_id | 请求ID
  szse_l1_index | 深交所指数快照行情
  error_info | 查询发生错误时返回的错误信息，当error_info为空，或者error_info.error_id为0时，表明没有错误

## ◆ on_query_szse_l1_snapshot()

virtual void on_query_szse_l1_snapshot | ( | uint64_t | session_id,
|  | uint64_t | request_id,
|  | szse_l1_snapshot_t * | szse_l1_snapshot,
|  | xlt_error_info_t * | error_info )
| inline virtual

查询最新深交所level1快照行情响应

参数

  session_id | 会话id，登录时得到
  request_id | 请求ID
  szse_l1_snapshot | 深交所L1快照行情
  error_info | 查询发生错误时返回的错误信息，当error_info为空，或者error_info.error_id为0时，表明没有错误

## ◆ on_query_szse_l1_snapshot_bond()

virtual void on_query_szse_l1_snapshot_bond | ( | uint64_t | session_id,
|  | uint64_t | request_id,
|  | szse_l1_snapshot_bond_t * | szse_l1_snapshot_bond,
|  | xlt_error_info_t * | error_info )
| inline virtual

查询最新深交所level1债券快照行情响应

参数

  session_id | 会话id，登录时得到
  request_id | 请求ID
  szse_l1_snapshot_bond | 深交所L1债券快照行情
  error_info | 查询发生错误时返回的错误信息，当error_info为空，或者error_info.error_id为0时，表明没有错误

## ◆ on_query_trades()

virtual void on_query_trades | ( | uint64_t | session_id,
|  | uint64_t | request_id,
|  | xlt_trade_report_t | trade_reports[],
|  | uint32_t | data_count,
|  | bool | is_last,
|  | xlt_error_info_t * | error_info )
| inline virtual

成交回报查询响应

参数

  session_id | 会话id，登录时得到
  request_id | 此消息响应函数对应的请求ID
  trade_reports | 本次响应返回的成交信息，个数由data_count决定
  data_count | 本次响应返回的数据条数
  is_last | 此消息响应函数是否为request_id这条请求所对应的最后一个响应，当为最后一个的时候为true，如果为false，表示还有其他后续消息响应
  error_info | 查询发生错误时，返回的错误信息，当error_info为空，或者error_info.error_id为0时，表明没有错误

备注
  需要快速返回，否则会堵塞后续消息，当堵塞严重时，会触发断线

## ◆ on_raw_report()

virtual void on_raw_report | ( | uint64_t | session_id,
|  | uint8_t | client_id,
|  | uint64_t | xid,
|  | char | report_id[32],
|  | uint64_t | sequence,
|  | ExchangeIndex | exchange_index,
|  | uint32_t | report_size,
|  | char * | raw_report )
| inline virtual

交易所原始订单执行报告（需用户自行解码）

此函数用于接收原始的订单执行报告。报告内容包括但不限于订单状态、执行细节等。 由于报告是原始形式，因此需要用户自行解码以获取具体信息。

参数

  session_id | 会话ID。
  client_id | 委托源标识，用户登录时自定义
  xid | 报单标识，通常是订单的唯一标识符。
  report_id | 回报标识，32字节，非字符串。
  sequence | 报告的序列号，通常用于标识报告的顺序，可能为0。
  exchange_index | 交易所索引，表示报告来自哪个交易所。
  report_size | 回报长度
  raw_report | 报告数据的指针，具体内容依赖于报告类型，需用户自行解码。

## ◆ on_request_timeout()

virtual void on_request_timeout | ( | uint64_t | session_id,
|  | uint64_t | request_id )
| inline virtual

查询超时通知

参数

  session_id | 会话id，登录时得到
  request_id | 超时请求ID

## ◆ on_trade_report()

virtual void on_trade_report | ( | uint64_t | session_id,
|  | xlt_trade_report_t * | trade_report )
| inline virtual

成交回报通知

此函数用于处理来自交易系统的成交回报通知。

参数

  session_id | 会话ID。
  trade_report | 成交回报通知数据指针。

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

- xlt_api.h