transport.hpp

Go to the documentation of this file.

#pragma once
 
 
#include <conduit/bus.hpp>
#include <conduit/envelope.hpp>
#include <conduit/exception.hpp>
#include <conduit/listener.hpp>
#include <conduit/serialization.hpp>
#include <conduit/transport.hpp>
 
#include <chrono>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
 
namespace conduit::zmq {
 
class ZmqError : public conduit::TransportError {
public:
    using conduit::TransportError::TransportError;
};
 
enum class Format : std::uint8_t { Json, Cbor };
 
enum class Pattern : std::uint8_t {
    PubSub,
    PushPull,
    RouterDealer,
};
 
enum class Role : std::uint8_t { Bind, Connect };
 
struct CurveConfig {
    std::string server_key;
    std::string public_key;
    std::string secret_key;
    bool is_server = false;
};
 
// NOLINTBEGIN(clang-analyzer-optin.performance.Padding)
// Layout is grouped by pattern (PubSub / PushPull / RouterDealer) for human
// readability; this Config is instantiated rarely (once per transport at
// startup), so the wasted padding is not worth scrambling the field order for.
struct Config {
    Pattern pattern = Pattern::PubSub;
 
    // PubSub — pub_endpoint is required when pattern == PubSub.
    std::string pub_endpoint;
    Role pub_role = Role::Connect;
    std::string sub_endpoint;
    Role sub_role = Role::Connect;
    std::string subscription_prefix;
 
    // PushPull — both endpoints required when pattern == PushPull.
    std::string push_endpoint;
    Role push_role = Role::Connect;
    std::string pull_endpoint;
    Role pull_role = Role::Bind;
 
    // RouterDealer — single bidirectional socket.
    std::string endpoint;
    Role endpoint_role = Role::Connect;
 
    std::optional<std::string> identity;
 
    std::chrono::milliseconds linger{0};
    int send_hwm = 1000;
    int recv_hwm = 1000;
 
    std::optional<CurveConfig> curve;
 
    Format format = Format::Cbor;
};
// NOLINTEND(clang-analyzer-optin.performance.Padding)
 
class Transport : public conduit::Transport {
public:
    explicit Transport(Config config, std::shared_ptr<EventRegistry> registry = {});
 
    Transport(const Transport&) = delete;
    Transport& operator=(const Transport&) = delete;
    Transport(Transport&&) = delete;
    Transport& operator=(Transport&&) = delete;
 
    ~Transport() override;
 
    [[nodiscard]] TransportScope scope() const noexcept override {
        return TransportScope::Remote;
    }
 
    void attach_with_sink(Bus& bus, InboundSink sink) override;
    void detach() noexcept override;
 
    void dispatch(const EventEnvelopeView& v) override;
    void flush() override;
 
    [[nodiscard]] bool is_connected() const noexcept;
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
}  // namespace conduit::zmq