mavtables  0.2.1
MAVLink router and firewall.
Public Member Functions | List of all members
PacketParser Class Reference

#include <PacketParser.hpp>

Collaboration diagram for PacketParser:
Collaboration graph

Public Member Functions

 PacketParser ()
 
 PacketParser (const PacketParser &other)=delete
 
 PacketParser (PacketParser &&other)=delete
 
size_t bytes_parsed () const
 
void clear ()
 
std::unique_ptr< Packetparse_byte (uint8_t byte)
 
PacketParseroperator= (const PacketParser &other)=delete
 
PacketParseroperator= (PacketParser &&other)=delete
 

Detailed Description

A MAVLink packet parser.

Parses wire protocol bytes into a MAVLink Packet.

Definition at line 33 of file PacketParser.hpp.

Constructor & Destructor Documentation

◆ PacketParser() [1/3]

PacketParser::PacketParser ( )

Construct a PacketParser.

Definition at line 32 of file PacketParser.cpp.

References clear().

Here is the call graph for this function:

◆ PacketParser() [2/3]

PacketParser::PacketParser ( const PacketParser other)
delete

◆ PacketParser() [3/3]

PacketParser::PacketParser ( PacketParser &&  other)
delete

Member Function Documentation

◆ bytes_parsed()

size_t PacketParser::bytes_parsed ( ) const

Return the number of bytes parsed on the current packet.

Returns
The number of bytes parsed on the current packet, 0 if no packet is currently being parsed.

Definition at line 44 of file PacketParser.cpp.

◆ clear()

void PacketParser::clear ( )

Reset packet parser so it can parse another packet.

If called while parsing a packet, that packet will be lost.

Definition at line 54 of file PacketParser.cpp.

References Packet::V2.

Here is the caller graph for this function:

◆ operator=() [1/2]

PacketParser& PacketParser::operator= ( const PacketParser other)
delete

◆ operator=() [2/2]

PacketParser& PacketParser::operator= ( PacketParser &&  other)
delete

◆ parse_byte()

std::unique_ptr< Packet > PacketParser::parse_byte ( uint8_t  byte)

Parse a MAVLink wire protocol byte, v1.0 or v2.0.

When a packet is completed it will be returned and the parser reset so it can be used to continue parsing.

Parameters
byteA byte from the MAVLink wire protocol.
Returns
A complete v1.0 or v2.0 packet. If the parser has not yet parsed a complete packet, nullptr is returned.

Definition at line 73 of file PacketParser.cpp.

Here is the caller graph for this function:

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