value_channel_set.hpp

Go to the documentation of this file.

#pragma once

 
#include <cstddef>
#include <cstdint>
#include <functional>
#include <memory>
#include <string>
#include <string_view>
#include <vector>
 
#include <pulp/dataplane/value_channel_telemetry.hpp>
 
namespace pulp::dataplane {
 
class ValueChannelSet;

using ValueChannelVisitor = std::function<void(ValueChannelSet*)>;
using ValueChannelAccess = std::function<void(const ValueChannelVisitor&)>;

class ValueChannelSet {
  public:
    ValueChannelSet() = default;
    ValueChannelSet(const ValueChannelSet&) = delete;
    ValueChannelSet& operator=(const ValueChannelSet&) = delete;
    ValueChannelSet(ValueChannelSet&&) = delete;
    ValueChannelSet& operator=(ValueChannelSet&&) = delete;

    std::uint64_t generation_identity() const noexcept;

    enum class DeclareError {
        ok,
        empty_name,
        duplicate_name,
        reserved_character, 
    };

    ScalarSource* declare_scalar(std::string name, std::string unit = {}, float neutral = 0.0f,
                                 DeclareError* error = nullptr);
    MeterSource* declare_meter(std::string name, std::string unit = {}, float neutral = 0.0f,
                               DeclareError* error = nullptr);
    VectorSource* declare_vector(std::string name, std::string unit = {}, float neutral = 0.0f,
                                 DeclareError* error = nullptr);
    EventSource* declare_events(std::string name, std::string unit = {},
                                DeclareError* error = nullptr);

    ScalarSource* scalar(std::string_view name) const;
    MeterSource* meter(std::string_view name) const;
    VectorSource* vector(std::string_view name) const;
    EventSource* events(std::string_view name) const;

    const std::vector<ValueChannelInfo>& infos() const noexcept {
        return infos_;
    }

    ValueChannelTelemetryAttachment attach_telemetry() const;
 
    bool empty() const noexcept {
        return infos_.empty();
    }
    std::size_t size() const noexcept {
        return infos_.size();
    }

    static const char* describe(DeclareError e) noexcept;
 
  private:
    struct Entry {
        std::shared_ptr<detail::ValueChannelTelemetryState> telemetry;
        std::unique_ptr<ScalarSource> scalar;
        std::unique_ptr<MeterSource> meter;
        std::unique_ptr<VectorSource> vector;
        std::unique_ptr<EventSource> events;
    };

    Entry* add_entry(std::string name, std::string unit, float neutral, ValueChannelShape shape,
                     DeclareError* error);
    std::ptrdiff_t index_of(std::string_view name, ValueChannelShape shape) const;

    std::vector<std::unique_ptr<Entry>> entries_;
    std::vector<ValueChannelInfo> infos_;
    // Keep the public object layout stable. The setup-only name index lives on
    // this existing opaque control sidecar.
    std::shared_ptr<detail::ValueChannelTelemetryControl> telemetry_control_;
};
 
} // namespace pulp::dataplane