pcpp::UdpLayer Class Reference

#include <UdpLayer.h>

Inheritance diagram for pcpp::UdpLayer:

Public Member Functions
	UdpLayer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
	UdpLayer (uint16_t portSrc, uint16_t portDst)
udphdr *	getUdpHeader () const
uint16_t	getSrcPort () const
uint16_t	getDstPort () const
uint16_t	calculateChecksum (bool writeResultToPacket)
void	parseNextLayer () override
size_t	getHeaderLen () const override
void	computeCalculateFields () override
	Calculate udphdr::headerChecksum field.
std::string	toString () const override
OsiModelLayer	getOsiModelLayer () 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	isDataValid (const uint8_t *data, size_t dataLen)

Additional Inherited Members
Protected Member Functions inherited from pcpp::Layer
template<typename T , typename... Args>
Layer *	constructNextLayer (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, Packet *packet, Args &&... extraArgs)
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 an UDP (User Datagram Protocol) protocol layer

Constructor & Destructor Documentation

UdpLayer() [1/2]

pcpp::UdpLayer::UdpLayer ( 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 (will be casted to udphdr)
[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

UdpLayer() [2/2]

pcpp::UdpLayer::UdpLayer	(	uint16_t	portSrc,
		uint16_t	portDst
	)

A constructor that allocates a new UDP header with source and destination ports

Parameters

[in]	portSrc	Source UDP port address
[in]	portDst	Destination UDP port

Member Function Documentation

calculateChecksum()

uint16_t pcpp::UdpLayer::calculateChecksum

(

bool

writeResultToPacket

)

Calculate the checksum from header and data and possibly write the result to udphdr::headerChecksum

Parameters

[in]

writeResultToPacket

If set to true then checksum result will be written to udphdr::headerChecksum

Returns

The checksum result

getDstPort()

uint16_t pcpp::UdpLayer::getDstPort

(

)

const

Returns

UDP destination port

getHeaderLen()

size_t pcpp::UdpLayer::getHeaderLen ( ) const

inlineoverridevirtual

Returns

Size of udphdr

Implements pcpp::Layer.

getOsiModelLayer()

OsiModelLayer pcpp::UdpLayer::getOsiModelLayer ( ) const

inlineoverridevirtual

Returns

The OSI Model layer this protocol belongs to

Implements pcpp::Layer.

getSrcPort()

uint16_t pcpp::UdpLayer::getSrcPort

(

)

const

Returns

UDP source port

getUdpHeader()

udphdr* pcpp::UdpLayer::getUdpHeader ( ) const

inline

Get a pointer to the UDP header. Notice this points directly to the data, so every change will change the actual packet data

Returns

A pointer to the udphdr

isDataValid()

bool pcpp::UdpLayer::isDataValid ( const uint8_t *  data, size_t  dataLen  )

inlinestatic

A static method that validates the input data

Parameters

[in]	data	The pointer to the beginning of a byte stream of an UDP packet
[in]	dataLen	The length of the byte stream

Returns

True if the data is valid and can represent a UDP packet

parseNextLayer()

void pcpp::UdpLayer::parseNextLayer ( )

overridevirtual

Currently identifies the following next layers: DnsLayer, DhcpLayer, VxlanLayer, SipRequestLayer, SipResponseLayer, RadiusLayer. Otherwise sets PayloadLayer

Implements pcpp::Layer.

toString()

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

overridevirtual

Returns

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

Implements pcpp::Layer.