NSQ

1. 预先编译的插件文件存放在 for Windows 或 for Linux 目录。将该目录下的所有文件（包括动态库文件）下载至 DolphinDB server 所在机器的如下目录：/DolphinDB/server/plugins/xxx。

2. 若使用 Linux 系统，在加载 NSQ 插件前，需为依赖库指定环境变量：

   export LD_LIBRARY_PATH= /your_plugin_path/:$LD_LIBRARY_PATH 

3. 启动 DolphinDB，加载插件：

   cd DolphinDB/server //进入DolphinDB server目录
   ./dolphindb //启动 DolphinDB server
   loadPlugin("/path/to/PluginNsq.txt");

   请注意，若使用 Windows 插件，加载时必须指定绝对路径，且路径中使用"\\"或"/"代替"\"。

Linux

使用 CMake 编译构建

首先，在 NSQ 插件文件夹下创建一个 build 文件夹，作为编译工作区。因为编译插件时需要链接 libDolphinDB.so （libDolphinDB.so 是运行 dolphindb 所依赖的库，非插件特有）。编译开始之前，需要将 dolphindb server 同级或上级目录下的 libDolphinDB.so 拷贝至 build 文件夹。

注意：在 nsq/lib 下，有针对不同操作系统的 NSQ SDK 库，分别存放于不同的文件夹，需要根据当前构建系统的类型拷贝其中一个动态库至 lib 目录（默认是 linux64）。在插件运行的时候也需要加载此 so 库，因此还需要拷贝到能识别该 so 文件的路径下（例如：dolphindb server 下与 libDolphinDB.so 同级的目录）。

mkdir build
cd build
cmake ..
make

Windows

Windows 系统下，需要将 ../nsq/lib/win32 或者 ../nsq/lib/win64 中的 HSNsqApi.dll 拷贝至 nsq/lib/ 目录。

1. 编译准备

   在 Windows 环境中需要使用 CMake 和 MinGW 进行编译，通过以下链接下载：

   • 下载安装 MinGW。确保将 bin 目录添加到系统环境变量 Path 中。
   • 下载安装 CMake。

2. 使用 CMake 构建

   首先，在 NSQ 插件文件夹下创建一个 build 文件夹，作为编译工作区。因为编译插件时需要链接 libDolphinDB.so （libDolphinDB.so 是运行 dolphindb 所依赖的库，非插件特有）。编译开始之前，需要将 dolphindb server 同级或上级目录下的 libDolphinDB.dll 拷贝至 build 文件夹。

   构建插件内容：

   	cd <PluginDir>\nsq
   	mkdir build                                             # 新建 build 目录
   	COPY <ServerDir>/libDolphinDB.dll build                 # 拷贝 libDolphinDB.dll 到 build 目录下
   	cd build
   	cmake  ../ -G "MinGW Makefiles"
   	mingw32-make -j

参数

configFilePath：一个字符串，表示 sdk_config.ini 的绝对路径；若拷贝 sdk_config.ini 至 dolphindb server，则可以是相对于 dolphindb server 的一个相对路径。 options：可选参数。是字典类型，表示扩展参数。当前键只支持 receivedTime 和 getAllFieldNames，receivedTime 表示是否显示接收时间，对应值为布尔值。 getAllFieldNames 表示是否接受所有字段数据，对应值为布尔值。详见后文示例。

详情

该函数将根据 NSQ 配置文件 sdk_config.ini 的配置，和行情服务器进行连接。连接成功后在日志文件 dolphindb.log 中会打印 “OnFrontConnected”。

请注意，再次执行 connect 进行重新连接前，需要先执行 nsq::close() 断开连接，否则会抛出异常。

参数

dataType：一个字符串，表示所要获取的表结构的类型，包含 snapshot, trade, orders。

详情

该函数需要在 connect 函数之后调用。后续根据 getSchema 返回的表结构创建流数据表。

参数

type：一个字符串，表示行情的类型，包含以下值：

• "snapshot"：表示回调函数 OnRtnSecuDepthMarketData（主推 - 现货深度行情）获取的行情数据。
• "trade"：表示回调函数 OnRtnSecuTransactionTradeData（主推 - 现货逐笔成交行情主）获取的行情数据。
• "orders"：表示回调函数 OnRtnSecuTransactionEntrustData（主推 - 现货逐笔委托行情）获取的行情数据。

location：一个字符串，表示上海证券交易所或深圳证券交易所。上海证券交易所用 sh 表示，深圳证券交易所用 sz 表示。 streamTable：表示一个共享流数据表的表对象。订阅前需要创建一个流数据表，且该流数据表的 schema 需要和获取的行情数据结构一致。请注意，建议设置为一个持久化后的流数据表对象（参见 enableTableShareAndPersistence 或 enableTablePersistence。否则，可能会发生 OOM。

详情

表示对上海证券交易所或深圳证券交易所发布的某种行情数据进行订阅，并将结果保存到由参数 streamTable 指定的流数据表中。

订阅成功后，在日志（dolphindb.log) 中会有打印如下信息(若出现 successfully，表示订阅成功)：

OnRspSecuTransactionSubscribe: nRequestID[0], ErrorID[0], ErrorMsg[subscribe all transaction trans type[1] of exchange_id [1] successfully]---------------------

注意：若需要将已经订阅的同一个(type, location) 的行情数据输出到另一个 streamTable，需要通过 unscribeTable 命令取消订阅，否则会抛出异常。

streamTable（流数据表）是一种特殊的内存表，用于存储及发布流数据。更多流数据表的使用方法可参考流计算监控。

参数

unsubscribe 命令的两个参数 type 和 location 的说明同 subscribe 的一致。

详情

表示取消对上海证券交易所或深圳证券交易所发布的某种行情数据的订阅，例如：unsubscribe(`snapshot, `sz) 表示取消对深圳证券交易所的 snapshot 行情数据的订阅。

取消订阅成功后，在日志（dolphindb.log) 中会有打印如下信息(若出现 successfully，表示取消订阅成功)：

OnRspSecuTransactionCancel: nRequestID[0], ErrorID[0], ErrorMsg[unsubscribe all transaction trans type [2] of exchange_id [2] successfully]---------------------

参数

无

详情

表示断开当前连接。如果修改了配置文件，则需要执行 close 后，再执行 connect，从而建立新的连接。

参数

无

详情

getSubscriptionStatus 是一个运维命令，用于获取当前连接状态，以及每个订阅的状态。

该函数会返回一个表，通过 select 语句来查看获取的状态，用法如下：

status = nsq::getSubscriptionStatus();
select * from status;

例如当前状态可能如下:

topicType     isConnected isSubscribed processedMsgCount lastErrMsg failedMsgCount lastFailedTimesconnecttamp
-------------- ----------- ------------ ----------------- ---------- -------------- -------------------
(snapshot, sh) true        true         0                            0
(snapshot, sz) true        true         0                            0
(trade, sh)    true        true         0                            0
(trade, sz)    true        true         0                            0
(orders, sh)    true        true         0                            0
(orders, sz)    true        true         0                            0