ares_frame_info Struct Reference

Serial buffer metadata that describes the location of a frame in a buffer, the size of the frame, and how many bytes need to be read before deserialization is possible. More...

#include <frame.h>

Data Fields
int	start_index
int	frame_size
int	bytes_left

Detailed Description

Serial buffer metadata that describes the location of a frame in a buffer, the size of the frame, and how many bytes need to be read before deserialization is possible.

Field Documentation

bytes_left

int ares_frame_info::bytes_left

Number of additional bytes needed for a complete frame.

Note

-1 if no frame header found.

frame_size

int ares_frame_info::frame_size

Size of the frame.

Note

-1 if no frame header was found.

start_index

int ares_frame_info::start_index

Start index.

Note

-1 If no frame header was found.

---

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

• firmware/include/serial/frame.h