ThreadedClient

ThreadedClient 针对每个订阅新建一个数据处理线程。每当发布端的流数据表产生新数据，其对应的订阅线程即会获取数据并调用回调函数。本小节将从构造函数、订阅和取消订阅对 ThreadedClient 进行介绍，并展示一个使用示例。

构造函数

ThreadedClient(int listeningPort = 0);

其中：listeningPort 表示单线程客户端的订阅端口号。

Note: 2.00.9 及之后版本的 server 发布端通过订阅端的请求连接推送数据，不再需要接收端指定端口，参数 listeningPort 填 0 或者不填即可。若进行指定，则该输入值无效，会被 API 忽略。
ThreadedClient(StreamingClientConfig config);

其中： StreamingClientConfig 为流订阅 API 的配置，当前定义如下：

enum class TransportationProtocol {
    TCP, UDP,
};
struct StreamingClientConfig {
    TransportationProtocol protocol{TransportationProtocol::TCP};
};

其中 protocol 为传输协议 ：

  • 为 TCP （默认值）时，与 3.00.2 及之前版本功能相同。

  • 为 UDP 时，通过 Aeron 库与 DolphinDB Server 进行 UDP 组播通信。

Note:

使用 UDP 协议时：

  • 当前 UDP 通信方式仅支持订阅接口1，且不支持 resub, filter, blobDeserializer, backupSites, resubscribeInterval, subOnce 等参数。

  • C++ API 仅支持在 Linux 下编译和运行。

  • C++ API 在编译时依赖于 Aeron 库，但对 Aeron 库的版本没有限制。

  • C++ API 以嵌入式 Aeron Media Driver 的方式运行，客户无需单独启动 Aeron 线程。

  • 当 C++ API 使用 UDP 进行流订阅时，会在/dev/shm目录下创建一个以 dolphindb_udp_<pid> 命名的文件夹供 Aeron 使用，订阅结束后会自动删除。如客户程序异常退出，请手动删除相关文件夹。

  • Server 须为 Linux 3.00.0 以上版本。

  • Server 每次发布的信息大小上限为 2MB。如果订阅未收到数据，请检查是否超过了该限制。如有需要，可以调整配置项 maxMsgNumPerBlock 以解决此问题。

订阅

//订阅接口1：
using MessageHandler = std::function<void(Message)>;
ThreadSP subscribe(
    string host, int port,
    const MessageHandler &handler,
    string tableName,
    string actionName = DEFAULT_ACTION_NAME,
    int64_t offset = -1,
    bool resub = true,
    const VectorSP &filter = nullptr,
    bool msgAsTable = false,
    bool allowExists = false, 
    string userName = "",
    string password = "",
    const StreamDeserializerSP &blobDeserializer = nullptr,
    const std::vector<std::string>& backupSites = std::vector<std::string>(),
    int resubscribeInterval = 100,
    bool subOnce = false,    
    int resubscribeTimeout = 0
)
//订阅接口2：
using MessageBatchHandler = std::function<void(vector<Message>)>;
ThreadSP subscribe(
    string host, int port,
    const MessageBatchHandler &handler,
    string tableName,
    string actionName = DEFAULT_ACTION_NAME,
    int64_t offset = -1,
    bool resub = true,
    const VectorSP &filter = nullptr,
    bool allowExists = false,
    int batchSize = 1,
    double throttle = 1,
    bool msgAsTable = false,
    string userName = "",
    string password = "",
    const StreamDeserializerSP &blobDeserializer = nullptr,
    const std::vector<std::string>& backupSites = std::vector<std::string>(),
    int resubscribeInterval = 100,
    bool subOnce = false,    
    int resubscribeTimeout = 0
)
Note:

接口区别说明

  • 订阅接口1：每收到一条消息时会立即回调，回调函数内必须完成对 Message 数据的访问。
  • 订阅接口2：采用缓存机制，通过 batchSize 和 throttle 进行控制，仅在满足条件时触发回调。每次回调可能包含多条消息。

参数

  • host：表示发布端节点的主机名。
  • port：表示发布端节点的端口号。
  • handler：表示用户自定义的回调函数，用于处理每次流入的消息。
  • tableName：表示发布端上共享流数据表的名称。
  • actionName：表示订阅任务的名称。传入值可以包含字母、数字和下划线。
  • offset：表示订阅任务开始后的第一条消息所在的位置。消息是流数据表中的行。如果没有指定 offset、或其为负数、或超过了流数据表的记录行数，则订阅将会从流数据表的当前行开始。offset 与流数据表创建时的第一行对应。如果某些行因为内存限制被删除，在决定订阅开始的位置时，这些行仍然考虑在内。
  • resub：表示订阅中断后，API 是否会自动重订阅。
  • filter：一个向量，表示过滤条件。流数据表过滤列在 filter 中的数据才会发布到订阅端，不在 filter 中的数据不会发布。
  • msgAsTable：只有设置了 batchSize 参数，该参数才会生效。若其设置为 true，则订阅的数据会转换为 Table；若其设置为 false，则订阅的数据会转换成 AnyVector。
  • allowExists：若该参数设置为 true，则支持对同一个订阅流表使用多个 handler 处理数据；若其设置为 False，则不支持同一个订阅流表使用多个 handler 处理数据。
  • batchSize：表示批处理的消息的数量。如果该参数是正数，则直到消息的数量达到 batchSize 时，handler 才会处理进来的消息；如果其未指定或者是非正数，则消息到达后，handler 会立刻处理消息。
  • throttle：表示 handler 处理到达的消息之前等待的时间，以秒为单位。默认值为 1。如果没有指定 batchSize，则 throttle 将不会起作用。
  • userName：表示 API 所连接服务器的登录用户名。
  • password：表示 API 所连接服务器的登录密码。
  • blobDeserializer：表示订阅的异构流表对应的反序列化器。
  • backupSites: 字符串列表，可选，表示备用的发布端节点列表，由节点 ip 和端口号组成，例如 [“192.168.0.1:8848“, “192.168.0.2:8849“]。
    • 指定backupSites，表示启动主备节点切换。如果发生节点切换（例如连接断开），会在可用节点列表中不断轮询订阅，直至订阅成功。
    • 若配置该参数，用户需保证主节点（由 host 和 port 参数指定）和备用节点上存在相同结构、相同数据的同名流数据表。否则，可能出现订阅的数据不符合预期。
    • 若订阅的是高可用流表，重连时将从 backupSites 指定的节点列表中选择节点。
    • 取消订阅需使用主节点 ip 和端口号进行取消。
  • resubscribeInterval：一个非负整数，表示在断连后每次尝试进行重新订阅的最小时间间隔（单位毫秒），默认值为 100。
  • subOnce：布尔值，False表示在节点切换时，不去尝试之前成功连接过的节点。默认值为 False。
  • resubscribeTimeout：整型，表示重订阅的超时时间（单位毫秒）。默认值为0，表示无限重试。建议配置 resub=true 时，同时配置该参数，以防止重订阅过程耗时太长而占用过多系统资源。
返回类型

ThreadSP 指向循环调用 handler 的线程的指针。该线程在此 topic 被取消订阅后会自动退出。

取消订阅

void unsubscribe( string host, int port, string tableName, string actionName )

参数值需要与订阅时的填入参数值相同。

使用示例

本例使用2.00.10版本的DolphinDB server

DolphinDB 脚本：新建一个 Stream 表，然后共享该表，名为shared_stream_table。

rt = streamTable(`XOM`GS`AAPL as id, 102.1 33.4 73.6 as x)
share rt as shared_stream_table

C++代码：从头订阅shared_stream_table，等待10秒后取消订阅。若在这10秒中发布端向shared_stream_table内追加数据，则订阅端可以实时得到数据。

#include <iostream>
#include "Streaming.h"
using namespace dolphindb;

int main(int argc, const char **argv)
{
    auto batchHandler = [](std::vector<Message> msgs){
        std::cout << "receive " << msgs.size() << " msgs\n";
        for(auto& msg : msgs){
            std::cout << msg->getString() << std::endl;
        }
    };
    ThreadedClient client(0);
    ThreadSP t = client.subscribe("127.0.0.1", 8848, batchHandler, "shared_stream_table", "action1", 0, true, nullptr, false, 3, 1.0);
    sleep(10);
    client.unsubscribe("127.0.0.1", 8848, "shared_stream_table", "action1");
    return 0;
}