pcpp::PayloadLayer Class Reference

#include <PayloadLayer.h>

Inheritance diagram for pcpp::PayloadLayer:

Public Member Functions
	PayloadLayer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
	PayloadLayer (const uint8_t *data, size_t dataLen, bool dummy)
uint8_t *	getPayload () const
size_t	getPayloadLen () const
void	parseNextLayer ()
size_t	getHeaderLen () const
void	computeCalculateFields ()
std::string	toString () const
OsiModelLayer	getOsiModelLayer () const
Public Member Functions inherited from pcpp::Layer
virtual	~Layer ()
Layer *	getNextLayer () const
Layer *	getPrevLayer () const
ProtocolType	getProtocol () 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

Detailed Description

Represents a generic or unknown layer or a packet payload

Constructor & Destructor Documentation

PayloadLayer() [1/2]

pcpp::PayloadLayer::PayloadLayer ( uint8_t *  data, size_t  dataLen, Layer *  prevLayer, Packet *  packet  )

inline

A constructor that creates the layer from an existing packet raw data

Parameters

[in]	data	A pointer to the raw data
[in]	dataLen	Size of the data in bytes
[in]	prevLayer	A pointer to the previous layer
[in]	packet	A pointer to the Packet instance where layer will be stored in

PayloadLayer() [2/2]

pcpp::PayloadLayer::PayloadLayer	(	const uint8_t *	data,
		size_t	dataLen,
		bool	dummy
	)

A constructor that allocates a new payload

Parameters

[in]	data	A raw buffer that will be used as a payload. This data will be copied to the layer
[in]	dataLen	The raw buffer length
[in]	dummy	A dummy parameter to separate the constructor signature from the other constructor. Its value isn't used anywhere

Member Function Documentation

computeCalculateFields()

void pcpp::PayloadLayer::computeCalculateFields ( )

inlinevirtual

Does nothing for this layer

Implements pcpp::Layer.

getHeaderLen()

size_t pcpp::PayloadLayer::getHeaderLen ( ) const

inlinevirtual

Returns

Payload data length in bytes

Implements pcpp::Layer.

getOsiModelLayer()

OsiModelLayer pcpp::PayloadLayer::getOsiModelLayer ( ) const

inlinevirtual

Returns

The OSI Model layer this protocol belongs to

Implements pcpp::Layer.

getPayload()

uint8_t* pcpp::PayloadLayer::getPayload ( ) const

inline

Get a pointer to the payload data

Returns

A pointer to the payload data

getPayloadLen()

size_t pcpp::PayloadLayer::getPayloadLen ( ) const

inline

Get the payload data length

Returns

The payload data length in bytes

parseNextLayer()

void pcpp::PayloadLayer::parseNextLayer ( )

inlinevirtual

Does nothing for this layer (PayloadLayer is always last)

Implements pcpp::Layer.

toString()

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

virtual

Returns

A string representation of the layer most important data (should look like the layer description in Wireshark)

Implements pcpp::Layer.