pcpp::ArpLayer Class Reference

#include <ArpLayer.h>

Inheritance diagram for pcpp::ArpLayer:

Public Member Functions
	ArpLayer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
	ArpLayer (ArpOpcode opCode, const MacAddress &senderMacAddr, const MacAddress &targetMacAddr, const IPv4Address &senderIpAddr, const IPv4Address &targetIpAddr)
arphdr *	getArpHeader () const
MacAddress	getSenderMacAddress () const
MacAddress	getTargetMacAddress () const
IPv4Address	getSenderIpAddr () const
IPv4Address	getTargetIpAddr () const
void	parseNextLayer ()
size_t	getHeaderLen () const
void	computeCalculateFields ()
bool	isRequest () const
bool	isReply () const
std::string	toString () const
OsiModelLayer	getOsiModelLayer () const
Public Member Functions inherited from pcpp::Layer
virtual	~Layer ()
Layer *	getNextLayer () const
Layer *	getPrevLayer () const
ProtocolType	getProtocol () 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

Detailed Description

Represents an ARP protocol layer. Currently only IPv4 ARP messages are supported

Constructor & Destructor Documentation

ArpLayer() [1/2]

pcpp::ArpLayer::ArpLayer ( 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 arphdr)
[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

ArpLayer() [2/2]

pcpp::ArpLayer::ArpLayer	(	ArpOpcode	opCode,
		const MacAddress &	senderMacAddr,
		const MacAddress &	targetMacAddr,
		const IPv4Address &	senderIpAddr,
		const IPv4Address &	targetIpAddr
	)

A constructor that allocates a new ARP header

Parameters

[in]	opCode	ARP message type (ARP request or ARP reply)
[in]	senderMacAddr	The sender MAC address (will be put in arphdr::senderMacAddr)
[in]	targetMacAddr	The target MAC address (will be put in arphdr::targetMacAddr)
[in]	senderIpAddr	The sender IP address (will be put in arphdr::senderIpAddr)
[in]	targetIpAddr	The target IP address (will be put in arphdr::targetIpAddr)

Member Function Documentation

computeCalculateFields()

void pcpp::ArpLayer::computeCalculateFields ( )

virtual

Calculate the following fields:

• arphdr::hardwareType = Ethernet (1)
• arphdr::hardwareSize = 6
• arphdr::protocolType = ETHERTYPE_IP (assume IPv4 over ARP)
• arphdr::protocolSize = 4 (assume IPv4 over ARP)
• if it's an ARP request: arphdr::targetMacAddr = MacAddress("00:00:00:00:00:00")

Implements pcpp::Layer.

getArpHeader()

arphdr* pcpp::ArpLayer::getArpHeader ( ) const

inline

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

Returns

A pointer to the arphdr

getHeaderLen()

size_t pcpp::ArpLayer::getHeaderLen ( ) const

inlinevirtual

Returns

The size of arphdr

Implements pcpp::Layer.

getOsiModelLayer()

OsiModelLayer pcpp::ArpLayer::getOsiModelLayer ( ) const

inlinevirtual

Returns

The OSI Model layer this protocol belongs to

Implements pcpp::Layer.

getSenderIpAddr()

IPv4Address pcpp::ArpLayer::getSenderIpAddr ( ) const

inline

Get the sender protocol address (SPA) in the form of IPv4Address

Returns

An IPv4Address containing the sender protocol address (SPA)

getSenderMacAddress()

MacAddress pcpp::ArpLayer::getSenderMacAddress ( ) const

inline

Get the sender hardware address (SHA) in the form of MacAddress

Returns

A MacAddress containing the sender hardware address (SHA)

getTargetIpAddr()

IPv4Address pcpp::ArpLayer::getTargetIpAddr ( ) const

inline

Get the target protocol address (TPA) in the form of IPv4Address

Returns

An IPv4Address containing the target protocol address (TPA)

getTargetMacAddress()

MacAddress pcpp::ArpLayer::getTargetMacAddress ( ) const

inline

Get the target hardware address (THA) in the form of MacAddress

Returns

A MacAddress containing the target hardware address (THA)

isReply()

bool pcpp::ArpLayer::isReply

(

)

const

Is this packet an ARP reply?

isRequest()

bool pcpp::ArpLayer::isRequest

(

)

const

Is this packet an ARP request?

parseNextLayer()

void pcpp::ArpLayer::parseNextLayer ( )

inlinevirtual

Does nothing for this layer (ArpLayer is always last)

Implements pcpp::Layer.

toString()

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

virtual

Returns

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

Implements pcpp::Layer.