#include <GtpLayer.h>

Inheritance diagram for pcpp::GtpV2Layer:

Public Member Functions
	GtpV2Layer (uint8_t data, size_t dataLen, Layer prevLayer, Packet *packet)

	GtpV2Layer (GtpV2MessageType messageType, uint32_t sequenceNumber, bool setTeid=false, uint32_t teid=0, bool setMessagePriority=false, std::bitset< 4 > messagePriority=0)

GtpV2MessageType	getMessageType () const

void	setMessageType (const GtpV2MessageType &type)

uint16_t	getMessageLength () const

bool	isPiggybacking () const

std::pair< bool, uint32_t >	getTeid () const

void	setTeid (uint32_t teid)

void	unsetTeid ()
	Unset Tunnel Endpoint Identifier (TEID) if exists in the layer (otherwise does nothing)

uint32_t	getSequenceNumber () const

void	setSequenceNumber (uint32_t sequenceNumber)

std::pair< bool, uint8_t >	getMessagePriority () const

void	setMessagePriority (const std::bitset< 4 > &messagePriority)

void	unsetMessagePriority ()
	Unset Message Priority if exists in the layer (otherwise does nothing)

GtpV2InformationElement	getFirstInformationElement () const

GtpV2InformationElement	getNextInformationElement (GtpV2InformationElement infoElement) const

GtpV2InformationElement	getInformationElement (GtpV2InformationElement::Type infoElementType) const

size_t	getInformationElementCount () const

GtpV2InformationElement	addInformationElement (const GtpV2InformationElementBuilder &infoElementBuilder)

GtpV2InformationElement	addInformationElementAfter (const GtpV2InformationElementBuilder &infoElementBuilder, GtpV2InformationElement::Type infoElementType)

bool	removeInformationElement (GtpV2InformationElement::Type infoElementType)

bool	removeAllInformationElements ()

void	parseNextLayer () override
	Identifies if the next layer is GTPv2 piggyback. Otherwise sets PayloadLayer.

size_t	getHeaderLen () const override

void	computeCalculateFields () override
	Computes the piggybacking flag by checking if the next layer is also a GTPv2 message.

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	isGTPv2Port (uint16_t port)

static bool	isDataValid (const uint8_t *data, size_t dataSize)

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

A class representing the GTPv2 defined in 3GPP TS 29.274

Constructor & Destructor Documentation

◆ GtpV2Layer() [1/2]

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

◆ GtpV2Layer() [2/2]

pcpp::GtpV2Layer::GtpV2Layer	(	GtpV2MessageType	messageType,
		uint32_t	sequenceNumber,
		bool	setTeid = `false`,
		uint32_t	teid = `0`,
		bool	setMessagePriority = `false`,
		std::bitset< 4 >	messagePriority = `0`
	)

A constructor that creates a new GTPv2 message

Parameters

messageType	GTPv2 message type
sequenceNumber	Message sequence number
setTeid	Whether or not to set Tunnel Endpoint Identifier in this message
teid	Tunnel Endpoint Identifier value. Only used if setTeid is set to true
setMessagePriority	Whether or not to set Message Priority in this message
messagePriority	Message Priority. Only used if setMessagePriority to true

Member Function Documentation

◆ addInformationElement()

GtpV2InformationElement pcpp::GtpV2Layer::addInformationElement ( const GtpV2InformationElementBuilder & infoElementBuilder )

Add a new Information Element (IE) at the end of the layer

Parameters

[in] infoElementBuilder A GtpV2InformationElementBuilder object that contains the requested IE data to add

Returns: A GtpV2InformationElement object containing the newly added IE data or logical null (GtpV2InformationElement::isNull() == true) if addition failed

◆ addInformationElementAfter()

GtpV2InformationElement pcpp::GtpV2Layer::addInformationElementAfter	(	const GtpV2InformationElementBuilder &	infoElementBuilder,
		GtpV2InformationElement::Type	infoElementType
	)

Add a new Information Element (IE) after an existing one

Parameters

[in]	infoElementBuilder	A GtpV2InformationElementBuilder object that contains the requested IE data to add
[in]	infoElementType	The IE type which the newly added option will come after

Returns: A GtpV2InformationElement object containing the newly added IE data or logical null (GtpV2InformationElement::isNull() == true) if addition failed

◆ getFirstInformationElement()

GtpV2InformationElement pcpp::GtpV2Layer::getFirstInformationElement ( ) const

Returns: The first GTPv2 Information Element (IE). If there are no IEs the returned value will contain a logical null (GtpV2InformationElement::isNull() == true)

◆ getHeaderLen()

size_t pcpp::GtpV2Layer::getHeaderLen ( ) const

overridevirtual

Returns: The size of the GTPv2 header including its Information Elements (IE)

Implements pcpp::Layer.

◆ getInformationElement()

GtpV2InformationElement pcpp::GtpV2Layer::getInformationElement ( GtpV2InformationElement::Type infoElementType ) const

Get a GTPv2 Information Element (IE) by type

Parameters

[in] infoElementType GTPv2 Information Element (IE) type

Returns: A GtpV2InformationElement object containing the first IE that matches this type, or logical null (GtpV2InformationElement::isNull() == true) if no such IE found

◆ getInformationElementCount()

size_t pcpp::GtpV2Layer::getInformationElementCount ( ) const

Returns: The number of GTPv2 Information Elements (IEs) in this layer

◆ getMessageLength()

uint16_t pcpp::GtpV2Layer::getMessageLength ( ) const

Returns: The message length as set in the layer. Note it is different from getHeaderLen() because the later refers to the entire layers length, and this property excludes the mandatory part of the GTP-C header (the first 4 octets)

◆ getMessagePriority()

std::pair<bool, uint8_t> pcpp::GtpV2Layer::getMessagePriority ( ) const

Get the Message Property if exists

Returns: A pair of 2 values; the first value states whether Message Priority exists, and if it's true the second value contains the Message Priority value

◆ getMessageType()

GtpV2MessageType pcpp::GtpV2Layer::getMessageType ( ) const

Returns: The message type

◆ getNextInformationElement()

GtpV2InformationElement pcpp::GtpV2Layer::getNextInformationElement ( GtpV2InformationElement infoElement ) const

Get the GTPv2 Information Element (IE) that comes after a given IE. If the given IE was the last one, the returned value will contain a logical null (GtpV2InformationElement::isNull() == true)

Parameters

[in] infoElement A given GTPv2 Information Element

Returns: A GtpV2InformationElement object containing the IE that comes next, or logical null if the given IE: (1) is the last one; (2) contains a logical null or (3) doesn't belong to this packet

◆ getOsiModelLayer()

OsiModelLayer pcpp::GtpV2Layer::getOsiModelLayer ( ) const

inlineoverridevirtual

Returns: The OSI Model layer this protocol belongs to

Implements pcpp::Layer.

◆ getSequenceNumber()

uint32_t pcpp::GtpV2Layer::getSequenceNumber ( ) const

Returns: The sequence number

◆ getTeid()

std::pair<bool, uint32_t> pcpp::GtpV2Layer::getTeid ( ) const

Get the Tunnel Endpoint Identifier (TEID) if exists

Returns: A pair of 2 values; the first value states whether TEID exists, and if it's true the second value contains the TEID value

◆ isDataValid()

static bool pcpp::GtpV2Layer::isDataValid	(	const uint8_t *	data,
		size_t	dataSize
	)

static

A static method that takes a byte array and detects whether it is a GTPv2 message

Parameters

[in]	data	A byte array
[in]	dataSize	The byte array size (in bytes)

Returns: True if the data is identified as GTPv2 message

◆ isGTPv2Port()

static bool pcpp::GtpV2Layer::isGTPv2Port ( uint16_t port )

inlinestatic

A static method that checks whether the port is considered as GTPv2

Parameters

[in] port The port number to be checked

Returns: True if the port matches those associated with the GTPv2 protocol

◆ isPiggybacking()

bool pcpp::GtpV2Layer::isPiggybacking ( ) const

Returns: True if there is another GTPv2 message piggybacking on this message (will appear as another GtpV2Layer after this layer)

◆ removeAllInformationElements()

bool pcpp::GtpV2Layer::removeAllInformationElements ( )

Remove all Information Elements (IE) in this layer

Returns: True if all IEs were successfully removed or false if removal failed for some reason

◆ removeInformationElement()

bool pcpp::GtpV2Layer::removeInformationElement ( GtpV2InformationElement::Type infoElementType )

Remove an existing Information Element (IE) from the layer

Parameters

[in] infoElementType The IE type to remove

Returns: True if the IE was successfully removed or false if type wasn't found or if removal failed

◆ setMessagePriority()

void pcpp::GtpV2Layer::setMessagePriority ( const std::bitset< 4 > & messagePriority )

Set Message Priority

Parameters

messagePriority The Message Priority value to set

◆ setMessageType()

void pcpp::GtpV2Layer::setMessageType ( const GtpV2MessageType & type )

Set message type

Parameters

type	The message type to set

◆ setSequenceNumber()

void pcpp::GtpV2Layer::setSequenceNumber ( uint32_t sequenceNumber )

Set the sequence number

Parameters

sequenceNumber The sequence number value to set

◆ setTeid()

void pcpp::GtpV2Layer::setTeid ( uint32_t teid )

Set Tunnel Endpoint Identifier (TEID)

Parameters

teid	The TEID value to set

◆ toString()

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

overridevirtual

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

Implements pcpp::Layer.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GtpV2Layer() [1/2]

◆ GtpV2Layer() [2/2]

Member Function Documentation

◆ addInformationElement()

◆ addInformationElementAfter()

◆ getFirstInformationElement()

◆ getHeaderLen()

◆ getInformationElement()

◆ getInformationElementCount()

◆ getMessageLength()

◆ getMessagePriority()

◆ getMessageType()

◆ getNextInformationElement()

◆ getOsiModelLayer()

◆ getSequenceNumber()

◆ getTeid()

◆ isDataValid()

◆ isGTPv2Port()

◆ isPiggybacking()

◆ removeAllInformationElements()

◆ removeInformationElement()

◆ setMessagePriority()

◆ setMessageType()

◆ setSequenceNumber()

◆ setTeid()

◆ toString()