mip_parser.h File Reference

#include "mip_packet.h"
#include "mip_offsets.h"
#include "utils/byte_ring.h"
#include "mip_types.h"

Go to the source code of this file.

Classes
struct	mip::C::mip_parser
	MIP Parser state. More...

Namespaces
	mip
	A collection of C++ classes and functions covering the full mip api.
	mip::C

Macros
#define	MIPPARSER_UNLIMITED_PACKETS   0
	Specifies no limit when used as the max_packets argument to mip_parser_parse. More...
#define	MIPPARSER_DEFAULT_TIMEOUT_MS   100
	Specifies the default timeout for a MIP parser, assuming timestamps are in milliseconds. More...

Typedefs
typedef bool(*	mip::C::mip_packet_callback) (void *user, const mip_packet_view *packet, mip_timestamp timestamp)
	Callback function which receives parsed MIP packets. More...
typedef struct mip::C::mip_parser	mip::C::mip_parser
	MIP Parser state. More...

Functions
void	mip::C::mip_parser_init (mip_parser *parser, uint8_t *buffer, size_t buffer_size, mip_packet_callback callback, void *callback_object, mip_timestamp timeout)
	Initializes the MIP parser. More...
bool	mip::C::mip_parser_parse_one_packet_from_ring (mip_parser *parser, mip_packet_view *packet_out, mip_timestamp timestamp)
	Parses a single packet from the internal buffer. More...
size_t	mip::C::mip_parser_parse (mip_parser *parser, const uint8_t *input_buffer, size_t input_count, mip_timestamp timestamp, unsigned int max_packets)
	Parses packets from the input data buffer. More...
void	mip::C::mip_parser_reset (mip_parser *parser)
	Resets the MIP parser. More...
size_t	mip::C::mip_parser_get_write_ptr (mip_parser *parser, uint8_t **const ptr_out)
	Obtain a pointer into which data may be read for processing. More...
void	mip::C::mip_parser_process_written (mip_parser *parser, size_t count, mip_timestamp timestamp, unsigned int max_packets)
	Notify the parser that data has been written to the pointer previously obtained via mip_parser_get_write_ptr(). More...
mip_timestamp	mip::C::mip_parser_timeout (const mip_parser *parser)
	Returns the packet timeout of the parser. More...
void	mip::C::mip_parser_set_timeout (mip_parser *parser, mip_timestamp timeout)
	Changes the timeout of the MIP parser. More...
void	mip::C::mip_parser_set_callback (mip_parser *parser, mip_packet_callback callback, void *callback_object)
	mip_parser_set_callback More...
mip_packet_callback	mip::C::mip_parser_callback (const mip_parser *parser)
	mip_parser_callback More...
void *	mip::C::mip_parser_callback_object (const mip_parser *parser)
	mip_parser_callback More...
mip_timestamp	mip::C::mip_parser_last_packet_timestamp (const mip_parser *parser)
	Gets the timestamp of the last parsed packet. More...
mip_timeout	mip::C::mip_timeout_from_baudrate (uint32_t baudrate)
	Computes an appropriate packet timeout for a given serial baud rate. More...