esphome-api-client 0.5.0
Modern C++17 client for the ESPHome native API (plaintext + Noise)
Loading...
Searching...
No Matches
Classes | Namespaces | Enumerations | Variables
frame_helper.hpp File Reference

Abstract frame codec: turns a byte stream into ESPHome message frames and back, independent of the underlying transport/socket. More...

#include <esphome/api/bytes.hpp>
#include <cstddef>
#include <cstdint>
#include <functional>
#include <string>
Include dependency graph for frame_helper.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  esphome::api::FrameHelper
 Stateful codec sitting between the transport and the connection. More...
 

Namespaces

namespace  esphome
 
namespace  esphome::api
 

Enumerations

enum class  esphome::api::FrameStatus { esphome::api::Ok , esphome::api::NeedMore }
 Result of attempting to pull a frame from the reassembly buffer. More...
 

Variables

constexpr std::size_t esphome::api::max_frame_payload = std::size_t{16} * 1024 * 1024
 Hard upper bound on a single frame's payload, guarding against a hostile or corrupt length prefix (16 MiB — comfortably above camera/BLE batches).
 

Detailed Description

Abstract frame codec: turns a byte stream into ESPHome message frames and back, independent of the underlying transport/socket.