pcpp::EthLayer Class Reference

#include <EthLayer.h>

Inheritance diagram for pcpp::EthLayer:

Public Member Functions
	EthLayer (uint8_t *data, size_t dataLen, Packet *packet)
	EthLayer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
	EthLayer (const MacAddress &sourceMac, const MacAddress &destMac, uint16_t etherType=0)
ether_header *	getEthHeader () const
MacAddress	getSourceMac () const
void	setSourceMac (const MacAddress &sourceMac)
MacAddress	getDestMac () const
void	setDestMac (const MacAddress &destMac)
void	parseNextLayer () override
size_t	getHeaderLen () const override
void	computeCalculateFields () override
	Calculate ether_header::etherType for known protocols: IPv4, IPv6, ARP, VLAN.
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
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 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)
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 Ethernet II protocol layer

Constructor & Destructor Documentation

EthLayer() [1/3]

pcpp::EthLayer::EthLayer ( uint8_t *  data, size_t  dataLen, 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 ether_header)
[in]	dataLen	Size of the data in bytes
[in]	packet	A pointer to the Packet instance where layer will be stored in

EthLayer() [2/3]

pcpp::EthLayer::EthLayer ( 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 ether_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

EthLayer() [3/3]

pcpp::EthLayer::EthLayer	(	const MacAddress &	sourceMac,
		const MacAddress &	destMac,
		uint16_t	etherType = 0
	)

A constructor that creates a new Ethernet header and allocates the data

Parameters

[in]	sourceMac	The source MAC address
[in]	destMac	The destination MAC address
[in]	etherType	The EtherType to be used. It's an optional parameter, a value of 0 will be set if not provided

Member Function Documentation

getDestMac()

MacAddress pcpp::EthLayer::getDestMac ( ) const

inline

Get the destination MAC address

Returns

The destination MAC address

getEthHeader()

ether_header* pcpp::EthLayer::getEthHeader ( ) const

inline

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

Returns

A pointer to the ether_header

getHeaderLen()

size_t pcpp::EthLayer::getHeaderLen ( ) const

inlineoverridevirtual

Returns

Size of ether_header

Implements pcpp::Layer.

getOsiModelLayer()

OsiModelLayer pcpp::EthLayer::getOsiModelLayer ( ) const

inlineoverridevirtual

Returns

The OSI Model layer this protocol belongs to

Implements pcpp::Layer.

getSourceMac()

MacAddress pcpp::EthLayer::getSourceMac ( ) const

inline

Get the source MAC address

Returns

The source MAC address

isDataValid()

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

static

A static method that validates the input data

Parameters

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

Returns

True if the data is valid and can represent an Ethernet II packet

parseNextLayer()

void pcpp::EthLayer::parseNextLayer ( )

overridevirtual

Currently identifies the following next layers: IPv4Layer, IPv6Layer, ArpLayer, VlanLayer, PPPoESessionLayer, PPPoEDiscoveryLayer, MplsLayer. Otherwise sets PayloadLayer

Implements pcpp::Layer.

setDestMac()

void pcpp::EthLayer::setDestMac ( const MacAddress &  destMac )

inline

Set destination MAC address

Parameters

destMac

Destination MAC to set

setSourceMac()

void pcpp::EthLayer::setSourceMac ( const MacAddress &  sourceMac )

inline

Set source MAC address

Parameters

sourceMac

Source MAC to set

toString()

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

overridevirtual

Returns

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

Implements pcpp::Layer.