MatchingEngineSimulator

版本要求

DolphinDB Server：2.00.9 及更高版本，支持 Linux x86-64, Linux JIT。

安装步骤

1. 在 DolphinDB 客户端中使用 listRemotePlugins 命令查看插件仓库中的插件信息。

   login("admin", "123456")
   listRemotePlugins("MatchingEngineSimulator")

2. 使用 installPlugin 命令完成插件安装。

   installPlugin("MatchingEngineSimulator")

3. 使用 loadPlugin 命令加载插件。

   loadPlugin("MatchingEngineSimulator")

createMatchEngine

语法

MatchingEngineSimulator::createMatchEngine(name, 
	exchange, 
	config, 
	dummyQuoteTable,
	quoteColMap, 
	dummyUserOrderTable,
	userOrderColMap, 
	orderDetailsOutput,
	[orderDetailsAndSnapshotOutput], 
	[snapshotOutput])

详情

创建一个模拟撮合引擎。

参数

• dummyQuoteTable：插入行情数据的表的实际结构，对于一些引擎内部使用到的列，由参数 quoteColMap 提供列名映射关系。

• quoteColMap：行情数据表的列名映射关系，一个字典标量，类型为(STRING, DOUBLE)。

  其中，对于逐笔模式，行情表必须提供的列如下：

对于快照模式，行情表必须提供的列如下：

对于分钟频率和日频数据，行情表必须提供的列如下：

• dummyUserOrderTable：插入用户订单数据的表的实际结构，对于一些引擎内部使用到的列，由参数 userOrderColMap 提供列名映射关系。

• userOrderColMap：用户订单表的列名映射关系，一个字典标量，类型为(STRING, DOUBLE)。

  • 股票，用户订单表必须提供的列如下：

• • 期货期权，用户订单表必须提供的列如下：

• orderDetailsAndSnapshotOutput：复合输出表，包含订单簿及用户订单成交委托详细情况表。需要调用 extractInfo 接口（详见后文该接口说明）来解析出具体数据。

• orderDetailsOutput：订单详情结果输出表(包括用户订单委托回报，成交、拒单以及撤单状态)。

  • 在配置项 outputRejectDetails 为 true 时（详见本接口的 config 参数说明），启用 outputRejectDetails 列。

  • 在配置项 outputQueuePosition 为 1 时（详见本接口的 config 参数说明），启用 openVolumeWithBetterPrice, openVolumeWithWorsePrice, openVolumeAtOrderPrice, priorOpenVolumeAtOrderPrice 和depthWithBetterPrice五列。

  • 在配置项 outputTimeInfo 为 1 时（详见本接口的 config 参数说明），启用 receiveTime, startMatchTime, endMatchTime 列。

• snapshotOutput：行情快照输出表。

返回值

一个模拟撮合引擎。

getOpenOrders

语法

MatchingEngineSimulator::getOpenOrders(engine, symbolList);

详情

获取未成交的用户订单信息。

参数

返回值

返回值是一个表。包含如下列：

注意：仅当 outputQueuePosition=1 时，包含 openVolumeWithBetterPrice, openVolumeWithWorsePrice, openVolumeAtOrderPrice, priorOpenVolumeAtOrderPrice, depthWithBetterPrice，

updateTime 五列。（详见 createMatchEngine 接口的 config 参数说明）

resetMatchEngine

语法

MatchingEngineSimulator::resetMatchEngine(engine)

详情

清空内部缓存的所有订单信息以及行情信息。

参数

engine：通过 createMatchEngine 接口创建的撮合引擎。

返回值

无。

getEngineList

语法

MatchingEngineSimulator::getEngineList();

详情

获取所有的 engine。

返回值

返回一个 engine 列表。类型为字典，key 为 ID，value 为 engine 对象。

getSymbolList

语法

MatchingEngineSimulator::getSymbolList(engine);

详情

获取某引擎中当前存在的股票 symbol 列表。

返回值

返回一个 STRING 类型的向量，包含当前存在的股票标的。

stopMatchEngine

语法

MatchingEngineSimulator::stopMatchEngine(engine, symbolList);

详情

停止模拟撮合引擎。

参数

• engine：通过 createMatchEngine 接口创建的撮合引擎。

• symbolList：字符串标量，可选参数，表示需要停止模拟的股票。若不填，则停止所有股票模拟。

extractInfo

语法

MatchingEngineSimulator::extractInfo(msgType, msg, [table]);

详情

解析 orderDetailsAndSnapshotOutput 表中的内容。（详见 createMatchEngine 接口的 orderDetailsAndSnapshotOutput 参数说明）

参数

返回值

如果指定 table，则将解析结果 append 到 table 的末尾中，并返回 true。

如果未指定 table，则返回解析结果。

insertMsg

语法

MatchingEngineSimulator::insertMsg(engine, msgBody, msgType);

详情

插入行情和用户订单数据。

参数

• engine：通过 createMatchEngine 接口创建的撮合引擎。

• msgBody：行情或用户订单数据。

• msgType：数据类型。1 表示行情，2 表示用户订单。

返回值

如果插入的是行情数据，返回 Void；

如果插入的是用户订单数据，返回用户的订单 ID（LONG 类型的向量）。

setLimitPrice

语法

MatchingEngineSimulator::setLimitPrice(engine, data);

详情

设置模拟撮合引擎的涨停价和跌停价。

注意：价格超过涨停价和跌停价范围内的用户订单都会被拒绝。

参数

返回值

如果设置成功，返回 true。

setPrevClose

语法

MatchingEngineSimulator::setPrevClose(engine, prevClose);

详情

设置模拟撮合引擎的前收盘价。

参数

• engine：通过 createMatchEngine 接口创建的撮合引擎。

• prevClose：一个字典。键值类型为 STRING-DOUBLE。字典的 key 为股票号，value 为对应股票的前收盘价。

返回值

如果设置成功，返回 true。

getSnapshot

语法

MatchingEngineSimulator::getSnapshot(engine, symbolList);

详情

获取逐笔引擎中的行情快照信息。

参数

• engine：是通过 createMatchEngine 接口创建的逐笔撮合引擎。

• symbolList： 股票标的，字符串向量。如果没有填该参数，表示获取所有股票标的快照。

返回值

返回一个表 ，结构如下：

例 1：通过自定义函数指定模拟撮合需要的参数

login("admin", "123456") //登录 loadPlugin("/DolphinDBPlugin/MatchingEngineSimulator/bin/PluginMatchingEngineSimulator.txt")
            //加载插件 go //用户订单 MARKET_OTHER_BEST = 3 MARKET_THIS_BEST = 2 MARKET_BEST_FIVE = 0 MARKET_INSTANT_DEAL = 1 MARKET_ALL_DEAL = 4 LIMIT_ORDER = 5 ORDER_CANCEL = 6 def initArgsSnapshotmode2(){     dummyQuoteTable = table(1:0,
            `symbol`symbolSource`timestamp`lastPrice`highestPrice2`lowestPrice2`highestPrice`lowestPrice`openPrice`preClosePrice`upLimitPrice`downLimitPrice`avgBidPrice`avgOfferPrice`totalBidQty`totalOfferQty`bidPrice`bidQty`offerPrice`offerQty`tradePrice`tradeQty,
            [STRING, STRING,
            TIMESTAMP,DOUBLE,DOUBLE,DOUBLE,DOUBLE,DOUBLE,DOUBLE,DOUBLE,DOUBLE,DOUBLE,DOUBLE, DOUBLE,
            LONG, LONG, DOUBLE[], LONG[], DOUBLE[], LONG[],DOUBLE[],LONG[]])     quoteColMap = dict(
            `symbol`symbolSource`timestamp`lastPrice`highestPrice`lowestPrice`highestPrice2`lowestPrice2`openPrice`preClosePrice`upLimitPrice`downLimitPrice`avgBidPrice`avgOfferPrice`totalBidQty`totalOfferQty`bidPrice`bidQty`offerPrice`offerQty`tradePrice`tradeQty,
            `symbol`symbolSource`timestamp`lastPrice`highestPrice`lowestPrice`highestPrice2`lowestPrice2`openPrice`preClosePrice`upLimitPrice`downLimitPrice`avgBidPrice`avgOfferPrice`totalBidQty`totalOfferQty`bidPrice`bidQty`offerPrice`offerQty`tradePrice`tradeQty)
                dummyUserOrderTable = table(1:0,
            `symbol`timestamp`orderType`price`orderQty`direction`orderId, [STRING, TIMESTAMP, INT,
            DOUBLE, LONG, INT, LONG])             userOrderColMap = dict(
            `symbol`timestamp`orderType`price`orderQty`direction`orderId,
            `symbol`timestamp`orderType`price`orderQty`direction`orderId)             orderDetailsOutput  = table(1:0,
            `orderId`symbol`direction`sendTime`orderPrice`orderQty`tradeTime`tradePrice`tradeQty`orderStatus`sysReceiveTime,
            [LONG, STRING, INT,TIMESTAMP,DOUBLE,LONG, TIMESTAMP,DOUBLE,LONG, INT,NANOTIMESTAMP])
                orderDetailsAndSnapshotOutput = table(1:0, `msgType`content, [INT, BLOB])
                snapshotOutput  = table(1:0,
            `symbol`timestamp`avgBidPrice`avgOfferPrice`totalBidQty`totalOfferQty`bidPrice`bidQty`offerPrice`offerQty`lastPrice`highPrice`lowPrice,
            [STRING, TIMESTAMP,DOUBLE,DOUBLE, LONG, LONG,DOUBLE[],LONG[], DOUBLE[],
            LONG[],DOUBLE,DOUBLE,DOUBLE])     return
            [dummyQuoteTable,quoteColMap,dummyUserOrderTable,userOrderColMap,orderDetailsOutput,orderDetailsAndSnapshotOutput,snapshotOutput]
            }

在上述代码中，

1. 登录 DolphinDB 客户端(login("admin", "123456"))并使用 loadPlugin 载入位于 /DolphinDBPlugin/MatchingEngineSimulator/bin/PluginMatchingEngineSimulator.txt 的插件。

2. 在 go 语句后指定用户订单。

定义了 initArgsSnapshotmode2 函数，并为各个命名函数指定需要执行的语句。

initArgsSnapshotmode2 返回一个包含多个表格和字典的列表，其中：

• dummyQuoteTable：报价表。

• quoteColMap：字典，用于映射报价表中的列名。

• dummyUserOrderTable：用户订单表。

• userOrderColMap：字典，用于映射用户订单表中的列名。

• orderDetailsOutput、snapshotOutput、orderDetailsAndSnapshotOutput 分别代表了交易输出、快照输出、复合输出表。

例 2：快照模式下以模式二模拟撮合委托订单

下例展示了在快照模式下以模式二（matchingMode = 2，详见 createMatchEngine 接口的 config 参数说明）模拟撮合证券交易市场委托订单的关键过程。

config = dict(STRING, DOUBLE); //定义了一个包含多个配置参数的字典
            config["latency"] = 0; //模拟时延 config["orderBookMatchingRatio"] = 0.12; //成交百分比 config["dataType"] = 1; // 行情类别为快照 config["outputOrderBook"] = 1; //是否输出订单，此处1表示输出 config["depth"] = 6; //匹配的订单簿的深度，区间为5到50，此处为6 config["matchingMode"] = 2; //快照模式下的匹配模式，此处为按照模式二撮合订单 name = "engine_snapshot" //指定引擎名称 exchange = "XSHE" //指定交易所名称 symbol = "AAA123" //指定证券代码 try{dropStreamEngine(name)}catch(ex){} args = initArgsSnapshotmode2() engine = MatchingEngineSimulator::createMatchEngine(name, exchange, config,
            args[0], args[1], args[2], args[3], args[4], args[5], args[6]) MatchingEngineSimulator::resetMatchEngine(engine) appendMsg(engine, (symbol, "XSHE", 2021.01.08
            10:14:01.400,23.5,,,25.0,23.0,,,,, 23.51, 23.59, 100, 100, [23.45  23.4  23.3  23.2
            23.1  23.0],  [1000 1000 1000 1000 1000 1000], [23.72  23.78  23.8  23.9  24.0 24.1],
            [1000 1000 1000 1000 1000 1000],[23.441 23.1235 23.653 23.771],[100 100 100 100]), 1)
            appendMsg(engine, (symbol, 2021.01.08 10:14:01.400, MARKET_THIS_BEST, 23.2, 200,
            ORDER_SEL, 1), 2)   // 23.72 appendMsg(engine, (symbol, 2021.01.08 10:14:01.400, MARKET_THIS_BEST, 23.3, 400,
            ORDER_SEL, 2), 2)  // 272 res = MatchingEngineSimulator::getOpenOrders(engine) ex = table([1,2] as orderId, [2021.01.08 10:14:01.400,2021.01.08 10:14:01.400]
            as timestamp, ["AAA123","AAA123"] as symbol, [23.72,23.72] as price, [200,400] as
            totalQty, [200,400] as openQty, [2,2] as BsFlag,  [true, true] as isMatching)
            assert 1, each(eqObj, res.values(), ex.values()) appendMsg(engine, (symbol, 2021.01.08 10:14:01.450, LIMIT_ORDER, 23.68, 400,
            ORDER_SEL, 2), 2)  // 23.68 appendMsg(engine, (symbol, "XSHE", 2021.01.08
            10:14:01.500,24.3,,,25.0,23.0,,,,, 23.51, 23.59, 1000, 1000, [23.45  23.4  23.3  23.2
            23.1  23.0],  [1000 1000 1000 1000 1000 1000], [23.72  23.78  23.8  23.9  24.0 24.1],
            [1000 1000 1000 1000 1000 1000],[23.65 23.81 23.73 23.72 23.45],[100 100 100 200 100]),
            1) appendMsg(engine, (symbol, "XSHE", 2021.01.08
            10:14:01.600,24.3,,,25.0,23.0,,,,, 23.51, 23.59, 1000, 1000, [23.45  23.4  23.3  23.2
            23.1  23.0],  [1000 1000 1000 1000 1000 1000], [23.67  23.78  23.8  23.9  24.0 24.1],
            [1000 1000 1000 1000 1000 1000],[23.72 0],[1200 0]), 1) res = select orderId, symbol, direction, sendTime, orderPrice, orderQty,
            tradeTime, tradePrice, tradeQty, orderStatus, sysReceiveTime from
        args[4]

在上述代码中，

• 定义了一个名为 config 的字典，它包含了一些配置参数，如模拟时延、成交百分比、行情类别、是否输出订单、订单簿深度等。

• 指定了引擎名称、交易所名称和证券代码。

• 还定义了一些函数，如 appendMsg 和 getOpenOrders，用于向引擎中添加消息和获取当前未完成的订单。

• 使用 assert 函数来验证结果是否符合预期。

其中，函数 dropStreamEngine 用于释放已创建的流数据引擎的定义，例如上述例子中的 name = "engine_snapshot"。