Guido Ottaviani / Mbed 2 deprecated LeonardoMbos

Dependencies:   mbos Watchdog TextLCD mbed ConfigFile

Embed: (wiki syntax)

« Back to documentation index

parser.h File Reference

parser.h File Reference

Go to the source code of this file.

Functions

int nmea_parser_init (nmeaPARSER *parser)
 Initialization of parser object.
void nmea_parser_destroy (nmeaPARSER *parser)
 Destroy parser object.
int nmea_parse (nmeaPARSER *parser, const char *buff, int buff_sz, nmeaINFO *info)
 Analysis of buffer and put results to information structure.
int nmea_parser_push (nmeaPARSER *parser, const char *buff, int buff_sz)
 Analysis of buffer and keep results into parser.
int nmea_parser_top (nmeaPARSER *parser)
 Get type of top packet keeped into parser.
int nmea_parser_pop (nmeaPARSER *parser, void **pack_ptr)
 Withdraw top packet from parser.
int nmea_parser_peek (nmeaPARSER *parser, void **pack_ptr)
 Get top packet from parser without withdraw.
int nmea_parser_drop (nmeaPARSER *parser)
 Delete top packet from parser.
int nmea_parser_buff_clear (nmeaPARSER *parser)
 Clear cache of parser.
int nmea_parser_queue_clear (nmeaPARSER *parser)
 Clear packets queue into parser.

Detailed Description

Definition in file parser.h.


Function Documentation

int nmea_parse ( nmeaPARSER *  parser,
const char *  buff,
int  buff_sz,
nmeaINFO info 
)

Analysis of buffer and put results to information structure.

Returns:
Number of packets wos parsed

Definition at line 77 of file parser.c.

int nmea_parser_buff_clear ( nmeaPARSER *  parser )

Clear cache of parser.

Returns:
true (1) - success

Definition at line 386 of file parser.c.

void nmea_parser_destroy ( nmeaPARSER *  parser )

Destroy parser object.

Definition at line 65 of file parser.c.

int nmea_parser_drop ( nmeaPARSER *  parser )

Delete top packet from parser.

Returns:
Deleted packet type
See also:
nmeaPACKTYPE

Definition at line 361 of file parser.c.

int nmea_parser_init ( nmeaPARSER *  parser )

Initialization of parser object.

Returns:
true (1) - success or false (0) - fail

Definition at line 39 of file parser.c.

int nmea_parser_peek ( nmeaPARSER *  parser,
void **  pack_ptr 
)

Get top packet from parser without withdraw.

Returns:
Received packet type
See also:
nmeaPACKTYPE

Definition at line 340 of file parser.c.

int nmea_parser_pop ( nmeaPARSER *  parser,
void **  pack_ptr 
)

Withdraw top packet from parser.

Returns:
Received packet type
See also:
nmeaPACKTYPE

Definition at line 315 of file parser.c.

int nmea_parser_push ( nmeaPARSER *  parser,
const char *  buff,
int  buff_sz 
)

Analysis of buffer and keep results into parser.

Returns:
Number of bytes wos parsed from buffer

Definition at line 271 of file parser.c.

int nmea_parser_queue_clear ( nmeaPARSER *  parser )

Clear packets queue into parser.

Returns:
true (1) - success

Definition at line 397 of file parser.c.

int nmea_parser_top ( nmeaPARSER *  parser )

Get type of top packet keeped into parser.

Returns:
Type of packet
See also:
nmeaPACKTYPE

Definition at line 297 of file parser.c.