frame.h

Go to the documentation of this file.

#pragma once
 
#include "librats/util/rats_export.h"
#include "librats/core/bytes.h"
 
#include <cstdint>
 
namespace librats {
 
enum class MessageType : uint8_t {
    App       = 1,
    Control   = 2,  
    Gossip    = 3,
    FileChunk = 4,
    Ping      = 5,  
    Storage   = 6,  
    Typed     = 7,  
    Pex       = 8,  
    Punch     = 9,  
    Relay     = 10, 
};
 
struct FrameHeader {
    MessageType type    = MessageType::App;
    uint8_t     flags   = 0;
    uint16_t    channel = 0;  
};
 
struct Frame {
    FrameHeader header;
    ByteView    payload;
};
 
namespace framer {
 
constexpr size_t   kLengthPrefixSize = 4;
constexpr size_t   kHeaderSize       = 4;                  
constexpr uint32_t kMaxBlockSize     = 64u * 1024 * 1024;  
 
// ── Outer block (length-prefixed opaque body) ───────────────────────────────
 
RATS_API void encode_block(Bytes& out, ByteView body);
 
RATS_API void encode_block_header(uint8_t* out, size_t body_size);
 
struct RATS_API Block {
    enum Status { Ok, Incomplete, Error } status = Incomplete;
    size_t   consumed = 0;  
    ByteView body{};        
 
    size_t   needed = 0;
};
 
RATS_API Block try_take_block(const uint8_t* data, size_t size);
 
// ── Inner message (fixed header + payload, no length prefix) ─────────────────
 
RATS_API void encode_message(Bytes& out, FrameHeader header, ByteView payload);
 
struct Message {
    bool  ok = false;
    Frame frame{};
};
 
RATS_API Message parse_message(ByteView inner);
 
} // namespace framer
} // namespace librats