Fawkes API  Fawkes Development Version
protobuf_comm::frame_header_t Struct Reference

Network framing header. More...

#include <frame_header.h>

Public Attributes

uint8_t header_version
 Frame header version. More...
 
uint8_t cipher
 One of PB_ENCRYPTION_*. More...
 
uint8_t reserved_2
 reserved for future use More...
 
uint8_t reserved_3
 reserved for future use More...
 
uint32_t payload_size
 payload size in bytes includes message and header, not IV More...
 

Detailed Description

Network framing header.

Header that is prepended to all messages. The payload size does not include the size of the header. All numbers are given in network byte order (big endian). The encryption type can be set if encryption is used. If the mode requires an initialization vector (IV) it is appended directly after the frame header (and not counted in the payload size).

Author
Tim Niemueller

Definition at line 74 of file frame_header.h.

Member Data Documentation

◆ cipher

◆ header_version

uint8_t protobuf_comm::frame_header_t::header_version

◆ payload_size

◆ reserved_2

uint8_t protobuf_comm::frame_header_t::reserved_2

reserved for future use

Definition at line 80 of file frame_header.h.

◆ reserved_3

uint8_t protobuf_comm::frame_header_t::reserved_3

reserved for future use

Definition at line 82 of file frame_header.h.


The documentation for this struct was generated from the following file: