frame_helper.hpp

Go to the documentation of this file.

#pragma once
 
 
#include <esphome/api/bytes.hpp>
 
#include <cstddef>
#include <cstdint>
#include <functional>
#include <string>
 
namespace esphome::api {
 
enum class FrameStatus {
    Ok,        
    NeedMore,  
};
 
class FrameHelper {
public:
    FrameHelper() = default;
    virtual ~FrameHelper() = default;
 
    FrameHelper(const FrameHelper&) = delete;
    FrameHelper& operator=(const FrameHelper&) = delete;
    FrameHelper(FrameHelper&&) = delete;
    FrameHelper& operator=(FrameHelper&&) = delete;
 
    virtual void encode(std::uint32_t msg_type, ByteView payload, ByteBuffer& out) = 0;
 
    virtual void feed(ByteView data) = 0;
 
    virtual FrameStatus next(std::uint32_t& out_type, ByteView& out_payload) = 0;
 
    // --- Handshake hooks (Noise overrides; plaintext is a no-op) -------------
 
    using HandshakeReady = std::function<void()>;
    using HandshakeError = std::function<void(const std::string& what)>;
 
    [[nodiscard]] virtual bool needs_handshake() const {
        return false;
    }
 
    virtual ByteBuffer connect_bytes() {
        return {};
    }
 
    // By value (not const ref) so overrides can move the callbacks into members;
    // this base no-op simply ignores them.
    // NOLINTNEXTLINE(performance-unnecessary-value-param)
    virtual void set_handshake_handlers(HandshakeReady /*on_ready*/, HandshakeError /*on_error*/) {}
};
 
inline constexpr std::size_t max_frame_payload = std::size_t{16} * 1024 * 1024;
 
}  // namespace esphome::api