fpsdk::common::parser::Parser Class Reference

Message parser class. More...

#include <parser.hpp>

Public Member Functions
	Parser ()
	Constructor, initialises parser and makes it ready to accept data and emit messages.
bool	Add (const uint8_t *data, const std::size_t size)
	Add data to parser.
bool	Add (const std::vector< uint8_t > &data)
	Add data to parser.
void	Reset ()
	Reset parser.
bool	Process (ParserMsg &msg)
	Process data in parser, return message.
bool	Flush (ParserMsg &msg)
	Get remaining data from parser as OTHER message(s)
ParserStats	GetStats () const
	Get parser statistics.

Detailed Description

Message parser class.

Definition at line 164 of file parser.hpp.

Member Function Documentation

Add() [1/2]

bool fpsdk::common::parser::Parser::Add	(	const uint8_t *	data,
		const std::size_t	size )

Add data to parser.

Parameters

[in]	data	Pointer to data
[in]	size	Size of data (should be <= MAX_ADD_SIZE)

Returns

true if data was added to the parser (or data was empty, that is, data != NULL and size = 0), false if there was not enough space left

Add() [2/2]

bool fpsdk::common::parser::Parser::Add

(

const std::vector< uint8_t > &

data

)

Add data to parser.

Parameters

[in]

data

data, can be empty (should be <= MAX_ADD_SIZE)

Returns

true if data was added to the parser (or data was empty), false if there was not enough space left

Reset()

void fpsdk::common::parser::Parser::Reset

(

)

Reset parser.

Resets the parser state and discards all collected data.

Process()

bool fpsdk::common::parser::Parser::Process

(

ParserMsg &

msg

)

Process data in parser, return message.

Parameters

[out]

msg

The detected message frame

Returns

true if a message was detected, false otherwise (meaning: not enough data in parser)

Flush()

bool fpsdk::common::parser::Parser::Flush

(

ParserMsg &

msg

)

Get remaining data from parser as OTHER message(s)

Parameters

[out]

msg

A chunk of the remaining data as a OTHER message

Returns

true if there was remaining data, false if parser buffer was empty

GetStats()

ParserStats fpsdk::common::parser::Parser::GetStats

(

)

const

Get parser statistics.

Returns

a copy of the parser statistics

References fpsdk::common::parser::MAX_ADD_SIZE, and fpsdk::common::parser::MAX_ANY_SIZE.

---

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

• fpsdk_common/include/fpsdk_common/parser.hpp