pcpp::PPPoESessionLayer Class Reference

#include <PPPoELayer.h>

Inheritance diagram for pcpp::PPPoESessionLayer:

Public Member Functions
	PPPoESessionLayer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
	PPPoESessionLayer (uint8_t version, uint8_t type, uint16_t sessionId, uint16_t pppNextProtocol)
uint16_t	getPPPNextProtocol () const
void	setPPPNextProtocol (uint16_t nextProtocol)
void	parseNextLayer () override
	Currently identifies the following next layers: IPv4Layer, IPv6Layer. Otherwise sets PayloadLayer.
size_t	getHeaderLen () const override
std::string	toString () const override
Public Member Functions inherited from pcpp::PPPoELayer
pppoe_header *	getPPPoEHeader () const
void	computeCalculateFields () override
	Calculate pppoe_header::payloadLength field.
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
Public Types inherited from pcpp::PPPoELayer
enum	PPPoECode {   PPPOE_CODE_SESSION = 0x00 , PPPOE_CODE_PADO = 0x07 , PPPOE_CODE_PADI = 0x09 , PPPOE_CODE_PADG = 0x0a ,   PPPOE_CODE_PADC = 0x0b , PPPOE_CODE_PADQ = 0x0c , PPPOE_CODE_PADR = 0x19 , PPPOE_CODE_PADS = 0x65 ,   PPPOE_CODE_PADT = 0xa7 , PPPOE_CODE_PADM = 0xd3 , PPPOE_CODE_PADN = 0xd4 }
	PPPoE possible codes. More...
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

Describes the PPPoE session protocol

Constructor & Destructor Documentation

PPPoESessionLayer() [1/2]

pcpp::PPPoESessionLayer::PPPoESessionLayer ( 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 pppoe_header)
[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

PPPoESessionLayer() [2/2]

pcpp::PPPoESessionLayer::PPPoESessionLayer ( uint8_t  version, uint8_t  type, uint16_t  sessionId, uint16_t  pppNextProtocol  )

inline

A constructor that allocates a new PPPoE Session header with version, type and session ID

Parameters

[in]	version	PPPoE version
[in]	type	PPPoE type
[in]	sessionId	PPPoE session ID
[in]	pppNextProtocol	The next protocol to come after the PPPoE session header. Should be one of the PPP_* macros listed below

Member Function Documentation

getHeaderLen()

size_t pcpp::PPPoESessionLayer::getHeaderLen ( ) const

inlineoverridevirtual

Returns

Size of pppoe_header

Implements pcpp::Layer.

getPPPNextProtocol()

uint16_t pcpp::PPPoESessionLayer::getPPPNextProtocol

(

)

const

Returns

The protocol after the PPPoE session header. The return value is one of the PPP_* macros listed below. This method is also used when parsing a packet (this way we know which layer comes after the PPPoE session)

isDataValid()

bool pcpp::PPPoESessionLayer::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 byte stream of a packet
[in]	dataLen	The length of the byte stream

Returns

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

setPPPNextProtocol()

void pcpp::PPPoESessionLayer::setPPPNextProtocol

(

uint16_t

nextProtocol

)

Set the field that describes which header comes after the PPPoE session header

Parameters

[in]

nextProtocol

The protocol value. Should be one of the PPP_* macros listed below

toString()

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

overridevirtual

Returns

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

Implements pcpp::Layer.