pcpp::MplsLayer Class Reference

#include <MplsLayer.h>

Inheritance diagram for pcpp::MplsLayer:

Public Member Functions
	MplsLayer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
	MplsLayer (uint32_t mplsLabel, uint8_t ttl, uint8_t experimentalUseValue, bool bottomOfStack)
uint8_t	getTTL () const
void	setTTL (uint8_t ttl)
bool	isBottomOfStack () const
void	setBottomOfStack (bool val)
uint8_t	getExperimentalUseValue () const
bool	setExperimentalUseValue (uint8_t val)
uint32_t	getMplsLabel () const
bool	setMplsLabel (uint32_t label)
void	parseNextLayer () override
	Currently identifies the following next layers: IPv4Layer, IPv6Layer, MplsLayer. Otherwise sets PayloadLayer.
size_t	getHeaderLen () const override
void	computeCalculateFields () override
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
	Copy the raw data of this layer to another array. More...
size_t	copyData (uint8_t *dest, size_t destSize) const
	Copy the raw data of this layer to another array, with a specified maximum size. More...
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
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...
void	allocData (size_t dataLen, bool zeroInit=true)
	Requests the layer to allocate a new data buffer of the specified length. 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 MPLS (Multi-Protocol Label Switching) layer

Constructor & Destructor Documentation

MplsLayer() [1/2]

pcpp::MplsLayer::MplsLayer ( 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

MplsLayer() [2/2]

pcpp::MplsLayer::MplsLayer	(	uint32_t	mplsLabel,
		uint8_t	ttl,
		uint8_t	experimentalUseValue,
		bool	bottomOfStack
	)

A constructor that allocates a new MPLS header

Parameters

[in]	mplsLabel	MPLS label
[in]	ttl	Time-to-leave value
[in]	experimentalUseValue	Experimental use value
[in]	bottomOfStack	Bottom-of-stack value which indicate whether the next layer will also be a MPLS label or not

Member Function Documentation

computeCalculateFields()

void pcpp::MplsLayer::computeCalculateFields ( )

overridevirtual

Set/unset the bottom-of-stack bit according to next layer: if it's a MPLS layer then bottom-of-stack will be unset. If it's not a MPLS layer this bit will be set

Implements pcpp::Layer.

getExperimentalUseValue()

uint8_t pcpp::MplsLayer::getExperimentalUseValue

(

)

const

Returns

The exp value (3 bits) of the MPLS label

getHeaderLen()

size_t pcpp::MplsLayer::getHeaderLen ( ) const

inlineoverridevirtual

Returns

Size of MPLS header (4 bytes)

Implements pcpp::Layer.

getMplsLabel()

uint32_t pcpp::MplsLayer::getMplsLabel

(

)

const

Returns

The MPLS label value (20 bits)

getOsiModelLayer()

OsiModelLayer pcpp::MplsLayer::getOsiModelLayer ( ) const

inlineoverridevirtual

Returns

The OSI Model layer this protocol belongs to

Implements pcpp::Layer.

getTTL()

uint8_t pcpp::MplsLayer::getTTL ( ) const

inline

Returns

TTL value of the MPLS header

isBottomOfStack()

bool pcpp::MplsLayer::isBottomOfStack

(

)

const

Get an indication whether the next layer is also be a MPLS label or not

Returns

True if it's the last MPLS layer, false otherwise

isDataValid()

static bool pcpp::MplsLayer::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 MPLS layer
[in]	dataLen	The length of the byte stream

Returns

True if the data is valid and can represent an MPLS layer

setBottomOfStack()

void pcpp::MplsLayer::setBottomOfStack

(

bool

val

)

Set the bottom-of-stack bit in the MPLS label

Parameters

[in]

val

Set or unset the bit

setExperimentalUseValue()

bool pcpp::MplsLayer::setExperimentalUseValue

(

uint8_t

val

)

Set the exp value (3 bits) of the MPLS label

Parameters

[in]

val

The exp value to set. val must be a valid number meaning between 0 and 7 (inclusive)

Returns

True if exp value was set successfully or false if val has invalid value

setMplsLabel()

bool pcpp::MplsLayer::setMplsLabel

(

uint32_t

label

)

Set the MPLS label (20 bits)

Parameters

[in]

label

The label to set. label must be a valid number meaning between 0 and 0xFFFFF (inclusive)

Returns

True if label was set successfully or false if label has invalid value

setTTL()

void pcpp::MplsLayer::setTTL ( uint8_t  ttl )

inline

Set the TTL value

Parameters

[in]

ttl

The TTL value to set

toString()

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

overridevirtual

Returns

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

Implements pcpp::Layer.