Clients

Covers Engine 2.0.0

ShareClientConfig

Configuration for the ready-to-use TEMPEST-compatible engine client.

API

Configuration for the ready-to-use TEMPEST-compatible engine client.

Namespace: DARTWIC::Share.

#include <dartwic/share/DARTWICShareClient.h>

Declaration

struct ShareClientConfig {
    // Nonempty local Share node name; choose a distinct name without channel-reference delimiters.
    std::string node_name;
    // Remote engine address.
    std::string host = "127.0.0.1";
    // Engine base port; telemetry uses base port + 1. Set explicitly to match the engine.
    int port = 7200;
    // Password configured by the remote engine.
    std::string password = "admin";
    // Maximum time to wait for a synchronous Share request.
    std::chrono::milliseconds request_timeout{5000};
    // Interval between transport heartbeats.
    std::chrono::milliseconds heartbeat_interval{1000};
    // Heartbeat timeout used to detect loss of the transport connection.
    std::chrono::milliseconds heartbeat_timeout{5000};
    // Initial reconnect backoff.
    std::chrono::milliseconds reconnect_initial_delay{100};
    // Maximum reconnect backoff.
    std::chrono::milliseconds reconnect_max_delay{5000};
};

DARTWICShareClient Inherited DARTWICShareProtocol API