pcpp::NDPLayerBase Class Reference

#include <NdpLayer.h>

Inheritance diagram for pcpp::NDPLayerBase:

Public Member Functions
size_t	getNdpOptionCount () const
NdpOption	getNdpOption (NDPNeighborOptionTypes option) const
NdpOption	getFirstNdpOption () const
NdpOption	getNextNdpOption (NdpOption &option) const
NdpOption	addNdpOption (const NdpOptionBuilder &optionBuilder)
bool	removeAllNdpOptions ()
Public Member Functions inherited from pcpp::IcmpV6Layer
	IcmpV6Layer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
	IcmpV6Layer (ICMPv6MessageType msgType, uint8_t code, const uint8_t *data, size_t dataLen)
bool	isMessageOfType (ICMPv6MessageType type) const
ICMPv6MessageType	getMessageType () const
uint8_t	getCode () const
uint16_t	getChecksum () const
void	parseNextLayer () override
	Does nothing for this layer. ICMPv6 is the last layer.
size_t	getHeaderLen () const override
void	computeCalculateFields () override
	Calculate ICMPv6 checksum field.
OsiModelLayer	getOsiModelLayer () const override
std::string	toString () 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

Additional Inherited Members
Static Public Member Functions inherited from pcpp::IcmpV6Layer
static Layer *	parseIcmpV6Layer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
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

Represents a base for NDP packet types

Member Function Documentation

addNdpOption()

NdpOption pcpp::NDPLayerBase::addNdpOption

(

const NdpOptionBuilder &

optionBuilder

)

Add a new NDP option at the end of the layer (after the last NDP option)

Parameters

[in]

optionBuilder

An NdpOptionBuilder object that contains the NDP option data to be added

Returns

A NdpOption object that contains the newly added NDP option data or logical null (NdpOption::isNull() == true) if addition failed. In case of a failure a corresponding error message will be printed to log

getFirstNdpOption()

NdpOption pcpp::NDPLayerBase::getFirstNdpOption

(

)

const

Returns

The first NDP option in the packet. If the current layer contains no options the returned value will contain a logical null (NdpOption::isNull() == true)

getNdpOption()

NdpOption pcpp::NDPLayerBase::getNdpOption

(

NDPNeighborOptionTypes

option

)

const

Get a NDP option by type.

Parameters

[in]

option

NDP option type

Returns

An NdpOption object that contains the first option that matches this type, or logical null (NdpOption::isNull() == true) if no such option found

getNdpOptionCount()

size_t pcpp::NDPLayerBase::getNdpOptionCount

(

)

const

Returns

The number of NDP options in this layer

getNextNdpOption()

NdpOption pcpp::NDPLayerBase::getNextNdpOption

(

NdpOption &

option

)

const

Get the NDP option that comes after a given option. If the given option was the last one, the returned value will contain a logical null (IdpOption::isNull() == true)

Parameters

[in]

option

An NDP option object that exists in the current layer

Returns

A NdpOption object that contains the NDP option data that comes next, or logical null if the given NDP option: (1) was the last one; or (2) contains a logical null; or (3) doesn't belong to this packet

removeAllNdpOptions()

bool pcpp::NDPLayerBase::removeAllNdpOptions

(

)

Remove all NDP options from the layer

Returns

True if options removed successfully or false if some error occurred (an appropriate error message will be printed to log)