mip_parser Struct Reference

MIP Parser state. More...

#include <mip_parser.h>

Private Attributes
mip_packet_callback	_callback
	Callback called when a valid packet is parsed. Can be NULL. More...
void *	_callback_object
	User-specified pointer passed to the callback function. More...
packet_length	_expected_length
	Expected length of the packet currently being parsed. Keeps track of parser state. Always 1, MIP_HEADER_LENGTH, or at least MIP_PACKET_LENGTH_MAX. More...
uint8_t	_result_buffer [MIP_PACKET_LENGTH_MAX]
	Buffer used to output MIP packets to the callback. More...
byte_ring_state	_ring
	Ring buffer which holds data being parsed. User-specified backing buffer and size. More...
timestamp_type	_start_time
	The timestamp when the first byte was observed by the parser. More...
timestamp_type	_timeout
	Duration to wait for the rest of the data in a packet. More...

Detailed Description

MIP Parser state.

Note

This should be considered an "opaque" structure; its members should be considered an internal implementation detail. Avoid accessing them directly as they are subject to change in future versions of this software.

Definition at line 55 of file mip_parser.h.

Member Data Documentation

_callback

mip_packet_callback mip_parser::_callback

private

Callback called when a valid packet is parsed. Can be NULL.

Definition at line 62 of file mip_parser.h.

_callback_object

void* mip_parser::_callback_object

private

User-specified pointer passed to the callback function.

Definition at line 63 of file mip_parser.h.

_expected_length

packet_length mip_parser::_expected_length

private

Expected length of the packet currently being parsed. Keeps track of parser state. Always 1, MIP_HEADER_LENGTH, or at least MIP_PACKET_LENGTH_MAX.

Definition at line 60 of file mip_parser.h.

_result_buffer

uint8_t mip_parser::_result_buffer[MIP_PACKET_LENGTH_MAX]

private

Buffer used to output MIP packets to the callback.

Definition at line 59 of file mip_parser.h.

_ring

byte_ring_state mip_parser::_ring

private

Ring buffer which holds data being parsed. User-specified backing buffer and size.

Definition at line 61 of file mip_parser.h.

_start_time

timestamp_type mip_parser::_start_time

private

The timestamp when the first byte was observed by the parser.

Definition at line 57 of file mip_parser.h.

_timeout

timestamp_type mip_parser::_timeout

private

Duration to wait for the rest of the data in a packet.

Definition at line 58 of file mip_parser.h.

---

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

• mip_parser.h