📝 docs(tsl): complete and lint codegen reference

This commit is contained in:
csh
2026-07-07 16:46:51 +08:00
parent 16e0992dd2
commit bbf6977f57
232 changed files with 39191 additions and 29763 deletions
@@ -1,6 +1,6 @@
# 算法交易 / 交易指令扩展及算法交易
### `tsAtGetParamterandDefaultValue(argv, name)`
## `TS_ATGetParamterandDefaultValue(argv, name)`
获得指定策略的缺省参数
@@ -11,7 +11,7 @@
返回:array
### `tsAtQuery(user_id, password, end_t, query_type, time_out)`
## `TS_ATQuery(user_id, password, end_t, query_type, time_out)`
查询账号相关信息,包括资金,持仓等
@@ -25,7 +25,7 @@
返回:array
### `tsAtQueryByOrderId(user_id, password, end_t, order_id, query_type, time_out)`
## `TS_ATQueryByOrderId(user_id, password, end_t, order_id, query_type, time_out)`
策略执行结果详情查询(按订单号)
@@ -40,7 +40,7 @@
返回:array
### `tsAtStart(h, time_out, err_str)`
## `TS_ATStart(h, time_out, err_str)`
启动指定策略
@@ -52,7 +52,7 @@
返回:string
### `tsAtStop(h, order_id, time_out)`
## `TS_ATStop(h, order_id, time_out)`
按照订单号停止指定策略
@@ -64,7 +64,7 @@
返回:any
### `tsOrderFuturePosition(addr, broker_id, account, password, stkid, position, cancel_threshold, comment)`
## `TSOrder_FuturePosition(addr, broker_id, account, password, stkid, position, cancel_threshold, comment)`
函数会自动维护指定品种的头寸。用户不需要进行复杂的事务处理、交易下单、交易撤单等,大大简化了应用开发。 委托价格是品种的当前价格。当委托价格偏离最新价格指定阀值(cancel_threshold)时撤单;cancel_threshold< 0 不撤单(禁用撤单功能) 服务器模式:每间隔指定时间(循环中),调用行情信号模块——计算当前头寸,同时调用本指令维护头寸。 客户端模式:每间隔指定时间(循环中),调用行情信号模块——计算当前头寸,同时使用RDO2调用本指令维护头寸(交易在客户端)。
@@ -81,7 +81,7 @@
返回:any
### `tsOrderFuturePositionCep(addr, broker_id, account, password, stkid, position, cancel_threshold, comment, act)`
## `TSOrder_FuturePosition_CEP(addr, broker_id, account, password, stkid, position, cancel_threshold, comment, act)`
本函数是对TSOrder_FuturePosition进行CEP封装,会每间隔1秒调用一次。 本指令每间隔1秒调用TSOrder_FuturePosition检查、维护指定品种头寸;运行参数为最后一次调用本函数(act=1设置头寸)的参数表。 服务器模式:本指令需要天软CEP(复杂事务处理)支持。可以订购指定品种行情事件、Timer事件,每当行情变动或定时器事件时,调用行情信号模块——计算当前头寸,同时调用本指令维护头寸。 客户端模式:天软客户端集成CEP(复杂事务处理),本指令可以通过RDO2推送到客户端运行。可以订购Timer事件(目前客户端暂不支持实时行情事件),每当定时器事件时,调用本指令维护头寸。
@@ -1,6 +1,6 @@
# 算法交易 / 算法交易服务器支撑事件函数
### `addEvent(msg_type, msg_identy, code, id_list, user_id)`
## `addEvent(msg_type, msg_identy, code, id_list, user_id)`
订购消息。
@@ -14,7 +14,7 @@
返回:any
### `getGlobalData(name)`
## `getGlobalData(name)`
取全局数据。
@@ -24,19 +24,19 @@
返回:any
### `listEvents()`
## `listEvents()`
获得当前设置的事件信息表。
返回:array
### `listGlobalData()`
## `listGlobalData()`
获得当前的全局数据信息列表。
返回:array
### `removeEvent(msg_identy)`
## `removeEvent(msg_identy)`
取消消息钩子。
@@ -46,7 +46,7 @@
返回:any
### `removeGlobalData(name)`
## `removeGlobalData(name)`
删除全局数据。
@@ -56,7 +56,7 @@
返回:bool
### `scheduleEvent(call_out_time, identy, code, user_id)`
## `scheduleEvent(call_out_time, identy, code, user_id)`
调度事件。 备注:TimerEvent与ScheduleEvent的差异的ScheduleEvent只做一次,做完会自动取消,而TimerEvent则会不断间隔做。
@@ -69,7 +69,7 @@
返回:any
### `sendEvent(msg_type, id_list, value)`
## `sendEvent(msg_type, id_list, value)`
给消息队列发送事件,如果成功则返回真。
@@ -81,7 +81,7 @@
返回:bool
### `setGlobalData(name, value)`
## `setGlobalData(name, value)`
设置全局数据。
@@ -92,7 +92,7 @@
返回:array
### `timerEvent(call_out_time, identy, code, user_id)`
## `timerEvent(call_out_time, identy, code, user_id)`
定时器事件。 备注:TimerEvent与ScheduleEvent的差异的ScheduleEvent只做一次,做完会自动取消,而TimerEvent则会不断间隔做。
@@ -1,6 +1,6 @@
# 算法交易 / 交易指令
### `ttCancelWt(h, entrust_id, batch_flag, timeout, comment, _async)`
## `TT_CancelWT(h, entrust_id, batch_flag, timeout, comment, _async)`
撤单接口。
@@ -11,11 +11,11 @@
| `batch_flag` | any | 整数,委托批号,输入;;(描述EntrustID参数输入的是委托号或委托批号。0-委托号,1-委托批号。以具体的柜台约定为准) |
| `timeout` | any | 整数,超时(单位毫秒),输入; |
| `comment` | string | 字符串,可选参数,说明信息,输入;(可以为每笔操作添加描述信息,以便区分每笔交易) |
| `_async` | any | 整数,可选参数,委托模式,输入;(0--同步模式、1--异步模式) |
| `_async` | any | 整数,可选参数,委托模式,输入;(0--同步模式、1--异步模式) |
返回:array
### `ttMultiWt(h, order_str, batch_no, timeout)`
## `TT_MultiWT(h, order_str, batch_no, timeout)`
批量委托接口。
@@ -28,7 +28,7 @@
返回:array
### `ttUserLogin(gate_way, account_type, account_id, account_pwd, timeout, errmsg)`
## `TT_UserLogin(gate_way, account_type, account_id, account_pwd, timeout, errmsg)`
交易账户登入接口。
@@ -43,7 +43,7 @@
返回:any
### `ttUserLogout(h, timeout)`
## `TT_UserLogout(h, timeout)`
交易账户注销接口。
@@ -54,7 +54,7 @@
返回:array
### `ttWt(h, bs, stk_id, price, vol, timeout, comment, _async)`
## `TT_WT(h, bs, stk_id, price, vol, timeout, comment, _async)`
委托接口。
@@ -67,6 +67,6 @@
| `vol` | any | 整数,委托数量,输入; |
| `timeout` | any | 整数,超时(单位毫秒),输入; |
| `comment` | string | 字符串,可选参数,说明信息,输入;(可以为每笔操作添加描述信息,以便区分每笔交易) |
| `_async` | any | 整数,可选参数,委托模式,输入;(0--同步模式、1--异步模式) |
| `_async` | any | 整数,可选参数,委托模式,输入;(0--同步模式、1--异步模式) |
返回:array
+22 -22
View File
@@ -1,6 +1,6 @@
# 算法交易 / TSOrder2
### `addLog(msg)`
## `add_log(msg)`
订单日志功能。
@@ -10,7 +10,7 @@
返回:any
### `cancelOrder(entrust_id)`
## `cancelOrder(entrust_id)`
撤单指定的子单。
@@ -20,19 +20,19 @@
返回:any
### `cancelOrder1()`
## `cancelOrder1()`
子单撤单指令1(根据预设的参数:argv\[‘撤单时间’\],argv\[‘价格撤单模式’\]等,撤掉所有符合条件的订单)
返回:any
### `cancelOrder2()`
## `cancelOrder2()`
子单撤单指令2(撤掉所有可撤的子单)
返回:any
### `create(url, header, onmessage, u, p, s, reconn)`
## `create(url, header, onmessage, u, p, s, reconn)`
构造方法
@@ -48,25 +48,25 @@
返回:any
### `doOrder()`
## `doOrder()`
虚方法,用户重载此方法,当指定品种行情到达、或定时器触发消息,会回调此函数,用户在此函数中下单、撤单或结束订单。
返回:any
### `getCdprice()`
## `get_cdprice()`
获得撤单价格(根据预设的参数:argv\[‘代码’\],argv\[‘交易方向’\],argv\[‘价格撤单-买卖盘参考档’\]等参数,获得撤单价格)
返回:float
### `getData()`
## `getData()`
返回用户创建订单的参数表
返回:array
### `getKey(key)`
## `get_key(key)`
获得订单个性化数据key的值
@@ -76,13 +76,13 @@
返回:any
### `getOid()`
## `getOid()`
返回订单号
返回:string
### `getOrders(o_type)`
## `getOrders(o_type)`
获取所有子单信息
@@ -92,7 +92,7 @@
返回:array
### `getPkVol(bs, n)`
## `get_pk_vol(bs, n)`
获得股票盘口数量(根据交易方向和行情档获得行情档下的盘口数量,如方向为”B”,行情档为二,则股票盘口数量为卖一量+卖二量)
@@ -103,13 +103,13 @@
返回:any
### `getPrice()`
## `get_price()`
获得交易价格(系统根据预设的参数:argv\[‘代码’\],argv\[‘交易方向’\], argv\['委托价类别'\]等自动计算委托价)。
返回:float
### `getValue(d_type, v1, v2)`
## `getValue(d_type, v1, v2)`
获取当前订单的状态信息。
@@ -121,19 +121,19 @@
返回:string
### `init()`
## `init()`
虚方法,订单被创建时调用此方法,用户重载此方法可以做相关订单初始化工作。
返回:any
### `isInit()`
## `isInit()`
订单是否初始化成功
返回:bool
### `release(msg)`
## `release(msg)`
结束订单。
@@ -143,7 +143,7 @@
返回:any
### `setKey(key, val)`
## `set_key(key, val)`
存贮订单个性化数据key-value
@@ -154,7 +154,7 @@
返回:any
### `sysLog(oid, msg)`
## `sysLog(oid, msg)`
将日志输出到系统日志中
@@ -165,7 +165,7 @@
返回:any
### `tOrder(bs, price, v, comment)`
## `tOrder(bs, price, v, comment)`
子单委托指令
@@ -178,7 +178,7 @@
返回:any
### `tOrder2(stkid, bs, price, v, comment)`
## `tOrder2(stkid, bs, price, v, comment)`
子单委托指令2(对于篮子订单,可以委托不同的股票及买卖方向)
@@ -192,7 +192,7 @@
返回:any
### `tOrder3(v, comment)`
## `tOrder3(v, comment)`
子单委托指令3(系统根据预设的参数自动获取买卖方向,买卖价格)