pcpp::DhcpV6Layer Class Reference

#include <DhcpV6Layer.h>

Inheritance diagram for pcpp::DhcpV6Layer:

Public Member Functions
	DhcpV6Layer (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
	DhcpV6Layer (DhcpV6MessageType messageType, uint32_t transactionId)
DhcpV6MessageType	getMessageType () const
std::string	getMessageTypeAsString () const
void	setMessageType (DhcpV6MessageType messageType)
uint32_t	getTransactionID () const
void	setTransactionID (uint32_t transactionId) const
DhcpV6Option	getFirstOptionData () const
DhcpV6Option	getNextOptionData (DhcpV6Option dhcpv6Option) const
DhcpV6Option	getOptionData (DhcpV6OptionType option) const
size_t	getOptionCount () const
DhcpV6Option	addOption (const DhcpV6OptionBuilder &optionBuilder)
DhcpV6Option	addOptionAfter (const DhcpV6OptionBuilder &optionBuilder, DhcpV6OptionType optionType)
DhcpV6Option	addOptionBefore (const DhcpV6OptionBuilder &optionBuilder, DhcpV6OptionType optionType)
bool	removeOption (DhcpV6OptionType optionType)
bool	removeAllOptions ()
void	parseNextLayer () override
size_t	getHeaderLen () const override
void	computeCalculateFields () override
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	isDhcpV6Port (uint16_t port)
static bool	isDataValid (const uint8_t *data, size_t dataLen)

Detailed Description

Represents a DHCPv6 (Dynamic Host Configuration Protocol version 6) protocol layer

Constructor & Destructor Documentation

DhcpV6Layer() [1/2]

pcpp::DhcpV6Layer::DhcpV6Layer	(	uint8_t *	data,
		size_t	dataLen,
		Layer *	prevLayer,
		Packet *	packet
	)

A constructor that creates the layer from an existing packet raw data

Parameters

[in]	data	A pointer to the raw data
[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

DhcpV6Layer() [2/2]

pcpp::DhcpV6Layer::DhcpV6Layer	(	DhcpV6MessageType	messageType,
		uint32_t	transactionId
	)

A constructor that creates the layer from scratch

Parameters

[in]	messageType	A DHCPv6 message type to be set
[in]	transactionId	The transaction ID to be set. Notice the transaction ID is 3-byte long so the value shouldn't exceed 0xFFFFFF

Member Function Documentation

addOption()

DhcpV6Option pcpp::DhcpV6Layer::addOption

(

const DhcpV6OptionBuilder &

optionBuilder

)

Add a new DHCPv6 option at the end of the layer

Parameters

[in]

optionBuilder

A DhcpV6OptionBuilder object that contains the requested DHCPv6 option data to add

Returns

A DhcpV6Option object containing the newly added DHCP option data or logical null (DhcpV6Option::isNull() == true) if addition failed

addOptionAfter()

DhcpV6Option pcpp::DhcpV6Layer::addOptionAfter	(	const DhcpV6OptionBuilder &	optionBuilder,
		DhcpV6OptionType	optionType
	)

Add a new DHCPv6 option after an existing one

Parameters

[in]	optionBuilder	A DhcpV6OptionBuilder object that contains the requested DHCPv6 option data to add
[in]	optionType	The DHCPv6 option type which the newly added option will come after

Returns

A DhcpV6Option object containing the newly added DHCPv6 option data or logical null (DhcpV6Option::isNull() == true) if addition failed

addOptionBefore()

DhcpV6Option pcpp::DhcpV6Layer::addOptionBefore	(	const DhcpV6OptionBuilder &	optionBuilder,
		DhcpV6OptionType	optionType
	)

Add a new DHCPv6 option before an existing one

Parameters

[in]	optionBuilder	A DhcpV6OptionBuilder object that contains the requested DHCPv6 option data to add
[in]	optionType	The DHCPv6 option type which the newly added option will come before

Returns

A DhcpV6Option object containing the newly added DHCPv6 option data or logical null (DhcpV6Option::isNull() == true) if addition failed

computeCalculateFields()

void pcpp::DhcpV6Layer::computeCalculateFields ( )

inlineoverridevirtual

Does nothing for this layer

Implements pcpp::Layer.

getFirstOptionData()

DhcpV6Option pcpp::DhcpV6Layer::getFirstOptionData

(

)

const

Returns

The first DHCPv6 option in the packet. If there are no DHCPv6 options the returned value will contain a logical null (DhcpV6Option::isNull() == true)

getHeaderLen()

size_t pcpp::DhcpV6Layer::getHeaderLen ( ) const

inlineoverridevirtual

Returns

The size of dhcpv6_header + size of options

Implements pcpp::Layer.

getMessageType()

DhcpV6MessageType pcpp::DhcpV6Layer::getMessageType

(

)

const

Returns

The message type of this DHCPv6 message

getMessageTypeAsString()

std::string pcpp::DhcpV6Layer::getMessageTypeAsString

(

)

const

Returns

The string value of the message type of this DHCPv6 message

getNextOptionData()

DhcpV6Option pcpp::DhcpV6Layer::getNextOptionData

(

DhcpV6Option

dhcpv6Option

)

const

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

Parameters

[in]

dhcpv6Option

A given DHCPv6 option

Returns

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

getOptionCount()

size_t pcpp::DhcpV6Layer::getOptionCount

(

)

const

Returns

The number of DHCPv6 options in this layer

getOptionData()

DhcpV6Option pcpp::DhcpV6Layer::getOptionData

(

DhcpV6OptionType

option

)

const

Get a DHCPv6 option by type

Parameters

[in]

option

DHCPv6 option type

Returns

A DhcpV6OptionType object containing the first DHCP option data that matches this type, or logical null (DhcpV6Option::isNull() == true) if no such option found

getOsiModelLayer()

OsiModelLayer pcpp::DhcpV6Layer::getOsiModelLayer ( ) const

inlineoverridevirtual

Returns

The OSI Model layer this protocol belongs to

Implements pcpp::Layer.

getTransactionID()

uint32_t pcpp::DhcpV6Layer::getTransactionID

(

)

const

Returns

The transaction ID of this DHCPv6 message

isDataValid()

bool pcpp::DhcpV6Layer::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 a byte stream of an DHCPv6 layer
[in]	dataLen	The length of the byte stream

Returns

True if the data is valid and can represent an DHCPv6 layer

isDhcpV6Port()

bool pcpp::DhcpV6Layer::isDhcpV6Port ( uint16_t  port )

inlinestatic

A static method that checks whether a port is considered as a DHCPv6 port

Parameters

[in]

port

The port number to check

Returns

True if this is a DHCPv6 port number, false otherwise

parseNextLayer()

void pcpp::DhcpV6Layer::parseNextLayer ( )

inlineoverridevirtual

Does nothing for this layer (DhcpV6Layer is always last)

Implements pcpp::Layer.

removeAllOptions()

bool pcpp::DhcpV6Layer::removeAllOptions

(

)

Remove all DHCPv6 options in this layer

Returns

True if all DHCPv6 options were successfully removed or false if removal failed for some reason

removeOption()

bool pcpp::DhcpV6Layer::removeOption

(

DhcpV6OptionType

optionType

)

Remove an existing DHCPv6 option from the layer

Parameters

[in]

optionType

The DHCPv6 option type to remove

Returns

True if DHCPv6 option was successfully removed or false if type wasn't found or if removal failed

setMessageType()

void pcpp::DhcpV6Layer::setMessageType

(

DhcpV6MessageType

messageType

)

Set the message type for this layer

Parameters

[in]

messageType

The message type to set

setTransactionID()

void pcpp::DhcpV6Layer::setTransactionID

(

uint32_t

transactionId

)

const

Set the transaction ID for this DHCPv6 message

Parameters

[in]

transactionId

The transaction ID value to set

toString()

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

overridevirtual

Returns

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

Implements pcpp::Layer.