#include <GreLayer.h>

Inheritance diagram for pcpp::GreLayer:

Classes
struct	SerializedFields

Public Member Functions
bool	getSequenceNumber (uint32_t &seqNumber) const

bool	setSequenceNumber (uint32_t seqNumber)

bool	unsetSequenceNumber ()

void	parseNextLayer () override

size_t	getHeaderLen () 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...

void	serialize (ISerializer &serializer) const

uint8_t *	getDataPtr (size_t offset=0) const override

virtual void	computeCalculateFields ()=0
	Each layer can compute field values automatically using this method. This is an abstract method.

virtual std::string	toString () const =0

Static Public Member Functions
static ProtocolType	getGREVersion (uint8_t *greData, size_t greDataLen)

Protected Member Functions
void	serializeLayer (ObjectScope &serializer) const override

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...

Additional Inherited Members
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

Abstract base class for GRE layers (GREv0Layer and GREv1Layer). Cannot be instantiated and contains common logic for derived classes

Member Function Documentation

◆ getGREVersion()

static ProtocolType pcpp::GreLayer::getGREVersion	(	uint8_t *	greData,
		size_t	greDataLen
	)

static

A static method that determines the GRE version of GRE layer raw data by looking at the gre_basic_header::version field

Parameters

[in]	greData	GRE layer raw data
[in]	greDataLen	Size of raw data

Returns: GREv0 or GREv1 values if raw data is GREv0 or GREv1 (accordingly) or UnknownProtocol otherwise

◆ getHeaderLen()

size_t pcpp::GreLayer::getHeaderLen ( ) const

overridevirtual

Returns: Size of GRE header (may change if optional fields are added or removed)

Implements pcpp::Layer.

◆ getOsiModelLayer()

OsiModelLayer pcpp::GreLayer::getOsiModelLayer ( ) const

inlineoverridevirtual

Returns: The OSI Model layer this protocol belongs to

Implements pcpp::Layer.

◆ getSequenceNumber()

bool pcpp::GreLayer::getSequenceNumber ( uint32_t & seqNumber ) const

Get sequence number value if field exists in layer

Parameters

[out] seqNumber The returned sequence number value if exists in layer. Else remain unchanged

Returns: True if sequence number field exists in layer. In this case seqNumber will be filled with the value. Or false if sequence number field doesn't exist in layer

◆ parseNextLayer()

void pcpp::GreLayer::parseNextLayer ( )

overridevirtual

Currently identifies the following next layers: IPv4Layer, IPv6Layer, VlanLayer, MplsLayer, PPP_PPTPLayer, EthLayer, EthDot3Layer Otherwise sets PayloadLayer

Implements pcpp::Layer.

◆ serializeLayer()

void pcpp::GreLayer::serializeLayer ( ObjectScope & serializer ) const

overrideprotectedvirtual

Serializes the layer's data into a provided serializer object. This is used for generating serialized representations (like JSON) of the packet layers. This method should be overridden by derived layers to provide specific serialization logic.

Parameters

[in] serializer The object scope serializer to which the layer details should be written.

Reimplemented from pcpp::Layer.

Reimplemented in pcpp::GREv1Layer, and pcpp::GREv0Layer.

◆ setSequenceNumber()

bool pcpp::GreLayer::setSequenceNumber ( uint32_t seqNumber )

Set sequence number value. If field already exists (gre_basic_header::sequenceNumBit is set) then only the new value is set. If field doesn't exist it will be added to the layer, gre_basic_header::sequenceNumBit will be set and the new value will be set

Parameters

[in] seqNumber The sequence number value to set

Returns: True if managed to set the value successfully, or false otherwise (if couldn't extend the layer)

◆ unsetSequenceNumber()

bool pcpp::GreLayer::unsetSequenceNumber ( )

Unset sequence number and remove it from the layer

Returns: True if managed to unset successfully or false (and error log) if sequence number wasn't set in the first place or if didn't manage to remove it from the layer

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getGREVersion()

◆ getHeaderLen()

◆ getOsiModelLayer()

◆ getSequenceNumber()

◆ parseNextLayer()

◆ serializeLayer()

◆ setSequenceNumber()

◆ unsetSequenceNumber()