pcpp::MySqlMessage Class Reference

#include <MySqlLayer.h>

Inheritance diagram for pcpp::MySqlMessage:

Public Member Functions
MySqlMessageType	getMessageType () const
MySqlMessageOrigin	getMessageOrigin () const
virtual uint32_t	getMessageLength () const
	Returns the length of the message payload. More...
uint8_t	getPacketNumber () const
	Returns the packet number. More...
size_t	getTotalMessageLength () const
	Returns the total length of the message including the length field. More...
virtual std::vector< uint8_t >	getRawPayload () const
	Returns the raw payload bytes of the message. More...

Static Public Member Functions
static std::unique_ptr< MySqlMessage >	parseMySqlMessage (const uint8_t *data, size_t dataLen, MySqlMessageOrigin origin)
	Parse a MySQL message from raw data. More...

Detailed Description

Represents a MySQL message (base class)

Member Function Documentation

getMessageLength()

virtual uint32_t pcpp::MySqlMessage::getMessageLength ( ) const

virtual

Returns the length of the message payload.

Returns

The message length

Reimplemented in pcpp::MySqlCommandMessage.

getMessageOrigin()

MySqlMessageOrigin pcpp::MySqlMessage::getMessageOrigin ( ) const

inline

Returns

The message origin (client or server)

getMessageType()

MySqlMessageType pcpp::MySqlMessage::getMessageType ( ) const

inline

Returns

The message type

getPacketNumber()

uint8_t pcpp::MySqlMessage::getPacketNumber

(

)

const

Returns the packet number.

Returns

The packet number

getRawPayload()

virtual std::vector<uint8_t> pcpp::MySqlMessage::getRawPayload ( ) const

virtual

Returns the raw payload bytes of the message.

Returns

The raw payload bytes of the message

Reimplemented in pcpp::MySqlCommandMessage.

getTotalMessageLength()

size_t pcpp::MySqlMessage::getTotalMessageLength ( ) const

inline

Returns the total length of the message including the length field.

Returns

The total message length in bytes

parseMySqlMessage()

static std::unique_ptr<MySqlMessage> pcpp::MySqlMessage::parseMySqlMessage ( const uint8_t *  data, size_t  dataLen, MySqlMessageOrigin  origin  )

static

Parse a MySQL message from raw data.

Parameters

[in]	data	A pointer to the raw data
[in]	dataLen	Size of the data in bytes
[in]	origin	The message origin (client or server)

Returns

A unique pointer to the parsed MySqlMessage, or nullptr if parsing fails