#include <MySqlLayer.h>

Inheritance diagram for pcpp::MySqlLayer:

Public Member Functions
	~MySqlLayer () override=default
	Destructor for this layer.

MySqlMessageOrigin	getMySqlOrigin () const

const PointerVector< MySqlMessage > &	getMySqlMessages () const

const MySqlMessage *	getMySqlMessage (const MySqlMessageType &messageType) const
	Get a MySQL message by its type. More...

template<class TMessage , std::enable_if_t< std::is_base_of< MySqlMessage, TMessage >::value, bool > = nullptr>
const TMessage *	getMySqlMessage () const
	Get a MySQL message by its type (template version) More...

size_t	getHeaderLen () const override

void	parseNextLayer () override
	Does nothing for this layer, MySQL is always last.

void	computeCalculateFields () override
	Does nothing for this layer.

OsiModelLayer	getOsiModelLayer () const override

std::string	toString () const override

Public Member Functions inherited from pcpp::Layer
	~Layer () override

Layer *	getNextLayer () const

Layer *	getPrevLayer () const

ProtocolType	getProtocol () const

bool	isMemberOfProtocolFamily (ProtocolTypeFamily protocolTypeFamily) const

uint8_t *	getData () const

size_t	getDataLen () const

uint8_t *	getLayerPayload () const

size_t	getLayerPayloadSize () const

bool	isAllocatedToPacket () const

void	copyData (uint8_t *toArr) const

uint8_t *	getDataPtr (size_t offset=0) const override

Static Public Member Functions
static bool	isMySqlPort (uint16_t port)
	Check whether the port is considered as MySQL. More...

static MySqlLayer *	parseMySqlClientMessage (uint8_t data, size_t dataLen, Layer prevLayer, Packet *packet)
	Parse a MySQL client message. More...

static MySqlLayer *	parseMySqlServerMessage (uint8_t data, size_t dataLen, Layer prevLayer, Packet *packet)
	Parse a MySQL server message. More...

Additional Inherited Members
Protected Member Functions inherited from pcpp::Layer
Packet *	getAttachedPacket ()
	Get a pointer to the Packet this layer is attached to (if any). More...

Packet const *	getAttachedPacket () const
	Get a pointer to the Packet this layer is attached to (if any). More...

template<typename T , typename... Args>
Layer *	constructNextLayer (uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Construct the next layer in the protocol stack. No validation is performed on the data. More...

template<typename T , typename... Args>
Layer *	constructNextLayer (uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)

template<typename TFactory , typename... Args>
Layer *	constructNextLayerFromFactory (TFactory factoryFn, uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Construct the next layer in the protocol stack using a factory functor. More...

template<typename TFactory , typename... Args>
Layer *	constructNextLayerFromFactory (TFactory factoryFn, uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)
	Construct the next layer in the protocol stack using a factory functor. More...

template<typename T , typename... Args>
Layer *	tryConstructNextLayer (uint8_t *data, size_t dataLen, Args &&... extraArgs)

template<typename T , typename... Args>
Layer *	tryConstructNextLayer (uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)

template<typename T , typename TFallback , typename... Args>
Layer *	tryConstructNextLayerWithFallback (uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack with a fallback option. More...

template<typename T , typename TFallback , typename... Args>
Layer *	tryConstructNextLayerWithFallback (uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)

template<typename TFallback , typename TFactory , typename... Args>
Layer *	tryConstructNextLayerFromFactoryWithFallback (TFactory factoryFn, uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack using a factory functor with a fallback option. More...

template<typename TFallback , typename TFactory , typename... Args>
Layer *	tryConstructNextLayerFromFactoryWithFallback (TFactory factoryFn, uint8_t data, size_t dataLen, Packet packet, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack using a factory functor with a fallback option. More...

Static Protected Member Functions inherited from pcpp::Layer
template<typename T >
static bool	canReinterpretAs (const uint8_t *data, size_t dataLen)
	Check if the data is large enough to reinterpret as a type. More...

Detailed Description

Represents a MySQL protocol layer

Member Function Documentation

◆ getHeaderLen()

size_t pcpp::MySqlLayer::getHeaderLen ( ) const

inlineoverridevirtual

Returns: The size of the MySQL layer header in bytes

Implements pcpp::Layer.

◆ getMySqlMessage() [1/2]

template<class TMessage , std::enable_if_t< std::is_base_of< MySqlMessage, TMessage >::value, bool > = nullptr>

const TMessage* pcpp::MySqlLayer::getMySqlMessage ( ) const

inline

Get a MySQL message by its type (template version)

Template Parameters

TMessage The message type to retrieve (must derive from MySqlMessage)

Returns: A pointer to the message of the specified type, or nullptr if not found

◆ getMySqlMessage() [2/2]

const MySqlMessage* pcpp::MySqlLayer::getMySqlMessage ( const MySqlMessageType & messageType ) const

Get a MySQL message by its type.

Parameters

[in] messageType The type of message to retrieve

Returns: A pointer to the message, or nullptr if not found

◆ getMySqlMessages()

const PointerVector<MySqlMessage>& pcpp::MySqlLayer::getMySqlMessages ( ) const

Returns: A vector of all MySQL messages in this layer

◆ getMySqlOrigin()

MySqlMessageOrigin pcpp::MySqlLayer::getMySqlOrigin ( ) const

inline

Returns: The message origin (client or server)

◆ getOsiModelLayer()

OsiModelLayer pcpp::MySqlLayer::getOsiModelLayer ( ) const

inlineoverridevirtual

Returns: The OSI layer level of MySQL (Application Layer).

Implements pcpp::Layer.

◆ isMySqlPort()

static bool pcpp::MySqlLayer::isMySqlPort ( uint16_t port )

inlinestatic

Check whether the port is considered as MySQL.

Parameters

[in] port The port number to be checked

Returns: True if the port is 3306 (MySQL default port), false otherwise

◆ parseMySqlClientMessage()

static MySqlLayer* pcpp::MySqlLayer::parseMySqlClientMessage	(	uint8_t *	data,
		size_t	dataLen,
		Layer *	prevLayer,
		Packet *	packet
	)

static

Parse a MySQL client message.

Parameters

[in]	data	A pointer to the raw data
[in]	dataLen	Size of the data in bytes
[in]	prevLayer	The previous layer
[in]	packet	The packet being parsed

Returns: A pointer to the parsed MySqlLayer, or nullptr if parsing fails

◆ parseMySqlServerMessage()

static MySqlLayer* pcpp::MySqlLayer::parseMySqlServerMessage	(	uint8_t *	data,
		size_t	dataLen,
		Layer *	prevLayer,
		Packet *	packet
	)

static

Parse a MySQL server message.

Parameters

[in]	data	A pointer to the raw data
[in]	dataLen	Size of the data in bytes
[in]	prevLayer	The previous layer
[in]	packet	The packet being parsed

Returns: A pointer to the parsed MySqlLayer, or nullptr if parsing fails

◆ toString()

std::string pcpp::MySqlLayer::toString ( ) const

overridevirtual

Returns: Returns the protocol info as readable string

Implements pcpp::Layer.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getHeaderLen()

◆ getMySqlMessage() [1/2]

◆ getMySqlMessage() [2/2]

◆ getMySqlMessages()

◆ getMySqlOrigin()

◆ getOsiModelLayer()

◆ isMySqlPort()

◆ parseMySqlClientMessage()

◆ parseMySqlServerMessage()

◆ toString()