proto_message.hpp

Go to the documentation of this file.

#pragma once
 
 
#include <esphome/api/proto/wire.hpp>
 
#include <cstddef>
#include <cstdint>
#include <cstring>
#include <memory>
#include <string>
 
namespace esphome::api {
 
class ProtoMessage {
public:
    ProtoMessage() = default;
    ProtoMessage(const ProtoMessage&) = default;
    ProtoMessage(ProtoMessage&&) = default;
    ProtoMessage& operator=(const ProtoMessage&) = default;
    ProtoMessage& operator=(ProtoMessage&&) = default;
    virtual ~ProtoMessage() = default;
 
    virtual void encode(ProtoWriter& writer) const = 0;
 
    virtual bool decode(ProtoReader& reader) = 0;
 
    [[nodiscard]] virtual std::size_t calculate_size() const = 0;
 
    [[nodiscard]] virtual std::uint32_t message_id() const = 0;
 
    [[nodiscard]] virtual const char* message_name() const = 0;
 
    [[nodiscard]] virtual std::unique_ptr<ProtoMessage> clone() const = 0;
 
    // --- protobuf-compatible wrappers (non-virtual) ------------------------
 
    [[nodiscard]] std::size_t ByteSizeLong() const {
        return calculate_size();
    }
 
    bool SerializeToArray(void* data, const int size) const {
        if (size < 0)
            return false;
        std::string buf;
        buf.reserve(static_cast<std::size_t>(size));
        ProtoWriter writer(buf);
        encode(writer);
        if (buf.size() != static_cast<std::size_t>(size))
            return false;
        if (!buf.empty())
            std::memcpy(data, buf.data(), buf.size());
        return true;
    }
 
    [[nodiscard]] std::string SerializeAsString() const {
        std::string buf;
        buf.reserve(calculate_size());
        ProtoWriter writer(buf);
        encode(writer);
        return buf;
    }
 
    bool ParseFromArray(const void* data, const int size) {
        if (size < 0)
            return false;
        ProtoReader reader(data, static_cast<std::size_t>(size));
        return decode(reader);
    }
};
 
class InfoResponseBase : public ProtoMessage {
public:
    [[nodiscard]] virtual std::uint32_t key() const = 0;
    [[nodiscard]] virtual const std::string& name() const = 0;
    [[nodiscard]] virtual const std::string& object_id() const = 0;
};
 
class StateResponseBase : public ProtoMessage {
public:
    [[nodiscard]] virtual std::uint32_t key() const = 0;
};
 
}  // namespace esphome::api