msgpack_serial_framing.hpp

Go to the documentation of this file.

 
#ifndef LSH_CORE_COMMUNICATION_MSGPACK_SERIAL_FRAMING_HPP
#define LSH_CORE_COMMUNICATION_MSGPACK_SERIAL_FRAMING_HPP
 
#include <stdint.h>
 
namespace lsh::core::transport
{
constexpr uint8_t MSGPACK_FRAME_END = 0xC0U;             
constexpr uint8_t MSGPACK_FRAME_ESCAPE = 0xDBU;          
constexpr uint8_t MSGPACK_FRAME_ESCAPED_END = 0xDCU;     
constexpr uint8_t MSGPACK_FRAME_ESCAPED_ESCAPE = 0xDDU;  
 
enum class MsgPackFrameConsumeResult : uint8_t
{
    Incomplete,     
    FrameComplete,  
    FrameDiscarded  
};
 
class MsgPackFrameReceiver
{
private:
    char *const frameBuffer;            
    const uint16_t frameCapacity;       
    uint16_t frameLengthBytes = 0U;     
    uint32_t lastByteTimeMs = 0U;       
    bool escapePending = false;         
    bool discardUntilFrameEnd = false;  
 
    [[nodiscard]] auto appendByte(uint8_t byte) -> bool;
    void startDiscarding() noexcept;
 
public:
    MsgPackFrameReceiver(char *buffer, uint16_t capacity) noexcept;
 
    void reset() noexcept;
    void resetIfIdle(uint32_t nowMs, uint32_t idleTimeoutMs) noexcept;
    [[nodiscard]] auto consumeByte(uint8_t byte, uint32_t nowMs) -> MsgPackFrameConsumeResult;
    [[nodiscard]] auto frameData() const -> const uint8_t *;
    [[nodiscard]] auto frameLength() const -> uint16_t;
};
 
}  // namespace lsh::core::transport
 
#endif  // LSH_CORE_COMMUNICATION_MSGPACK_SERIAL_FRAMING_HPP