value_channel_telemetry_broker.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/inspect/inspector_delivery.hpp>
#include <pulp/view/value_channel_telemetry.hpp>
 
#include <chrono>
#include <cstddef>
#include <cstdint>
#include <functional>
#include <memory>
#include <string_view>
 
namespace pulp::inspect {

class ValueChannelTelemetryBroker {
  public:
    using Clock = std::function<std::chrono::steady_clock::time_point()>;
    using EventSink = InspectorTargetedEventSink;
    using EventRetirementSink = InspectorEventRetirementSink;
 
    struct Config {
        double default_rate_hz = 15.0;
        double max_rate_hz = 60.0;
        std::size_t max_channels = 32;
        std::size_t max_vector_values = 512;
        std::size_t max_events_per_channel = 128;
        std::size_t max_wire_bytes = 64u * 1024u;
        std::chrono::milliseconds stale_after = std::chrono::milliseconds(500);
    };
 
    ValueChannelTelemetryBroker();
    explicit ValueChannelTelemetryBroker(Config config, Clock clock = {});
    ~ValueChannelTelemetryBroker();
    ValueChannelTelemetryBroker(ValueChannelTelemetryBroker&&) noexcept;
    ValueChannelTelemetryBroker& operator=(ValueChannelTelemetryBroker&&) noexcept;
    ValueChannelTelemetryBroker(const ValueChannelTelemetryBroker&) = delete;
    ValueChannelTelemetryBroker& operator=(const ValueChannelTelemetryBroker&) = delete;
 
    void set_event_sink(EventSink sink);
    void set_event_retirement_sink(EventRetirementSink sink);

    bool replace_attachment(view::ValueChannelTelemetryAttachment attachment);
    void replace_with_empty_source();
    void clear_attachment();

    InspectorMessage handle(const InspectorRequestContext& context,
                            const InspectorMessage& request);

    void poll();
    void disconnect(std::string_view client_id);
    std::size_t subscription_count() const noexcept;
    std::uint64_t source_generation() const noexcept;
 
  private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
} // namespace pulp::inspect