Fawkes API  Fawkes Development Version
protobuf_comm::frame_header_v1_t Struct Reference

Old network message framing header. More...

#include <frame_header.h>

Public Attributes

uint16_t component_id
 component id More...
 
uint16_t msg_type
 message type More...
 
uint32_t payload_size
 payload size in bytes More...
 

Detailed Description

Old network message framing header.

Header that is prepended to all messages. The component ID can be used to route a message to a particular software component. The component then can use the message type to determine how the message must be parse the payload. It is appended immediately following the header. The payload size does not include the size of the header. All numbers are given in network byte order (big endian).

Author
Tim Niemueller

Definition at line 115 of file frame_header.h.

Member Data Documentation

◆ component_id

uint16_t protobuf_comm::frame_header_v1_t::component_id

◆ msg_type

uint16_t protobuf_comm::frame_header_v1_t::msg_type

◆ payload_size

uint32_t protobuf_comm::frame_header_v1_t::payload_size

payload size in bytes

Definition at line 122 of file frame_header.h.

Referenced by protobuf_comm::ProtobufStreamClient::send(), and protobuf_comm::ProtobufBroadcastPeer::send().


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