#include <IgmpLayer.h>

Inheritance diagram for pcpp::IgmpV3ReportLayer:

Public Member Functions
	IgmpV3ReportLayer (uint8_t data, size_t dataLen, Layer prevLayer, Packet *packet)

	IgmpV3ReportLayer ()
	A constructor that allocates a new IGMPv3 membership report with 0 group addresses.

igmpv3_report_header *	getReportHeader () const

uint16_t	getGroupRecordCount () const

igmpv3_group_record *	getFirstGroupRecord () const

igmpv3_group_record *	getNextGroupRecord (igmpv3_group_record *groupRecord) const

igmpv3_group_record *	addGroupRecord (uint8_t recordType, const IPv4Address &multicastAddress, const std::vector< IPv4Address > &sourceAddresses)

igmpv3_group_record *	addGroupRecordAtIndex (uint8_t recordType, const IPv4Address &multicastAddress, const std::vector< IPv4Address > &sourceAddresses, int index)

bool	removeGroupRecordAtIndex (int index)

bool	removeAllGroupRecords ()

void	computeCalculateFields () override
	Calculate the IGMP checksum.

size_t	getHeaderLen () const override

Public Member Functions inherited from pcpp::IgmpLayer
igmp_header *	getIgmpHeader () const

IPv4Address	getGroupAddress () const

void	setGroupAddress (const IPv4Address &groupAddr)

IgmpType	getType () const

void	setType (IgmpType type)

void	parseNextLayer () override
	Does nothing for this layer (IGMP layer is always last)

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
	Copy the raw data of this layer to another array. More...

size_t	copyData (uint8_t *dest, size_t destSize) const
	Copy the raw data of this layer to another array, with a specified maximum size. More...

uint8_t *	getDataPtr (size_t offset=0) const override

Static Public Member Functions
static bool	isDataValid (uint8_t const *data, size_t dataLen)

Static Public Member Functions inherited from pcpp::IgmpLayer
static ProtocolType	getIGMPVerFromData (uint8_t *data, size_t dataLen, bool &isQuery)

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...

void	allocData (size_t dataLen, bool zeroInit=true)
	Requests the layer to allocate a new data buffer of the specified length. 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 an IGMPv3 (Internet Group Management Protocol ver 3) membership report message

Constructor & Destructor Documentation

◆ IgmpV3ReportLayer()

pcpp::IgmpV3ReportLayer::IgmpV3ReportLayer	(	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
[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

Member Function Documentation

◆ addGroupRecord()

igmpv3_group_record* pcpp::IgmpV3ReportLayer::addGroupRecord	(	uint8_t	recordType,
		const IPv4Address &	multicastAddress,
		const std::vector< IPv4Address > &	sourceAddresses
	)

Add a new group record at a the end of the group record list. The igmpv3_report_header::numOfGroupRecords field will be incremented accordingly

Parameters

[in]	recordType	The type of the new group record
[in]	multicastAddress	The multicast address of the new group record
[in]	sourceAddresses	A vector containing all the source addresses of the new group record

Returns: The method constructs a new group record, adds it to the end of the group record list of IGMPv3 report message and returns a pointer to the new message. If something went wrong in creating or adding the new group record a nullptr value is returned and an appropriate error message is printed to log

◆ addGroupRecordAtIndex()

igmpv3_group_record* pcpp::IgmpV3ReportLayer::addGroupRecordAtIndex	(	uint8_t	recordType,
		const IPv4Address &	multicastAddress,
		const std::vector< IPv4Address > &	sourceAddresses,
		int	index
	)

Add a new group record at a certain index of the group record list. The igmpv3_report_header::numOfGroupRecords field will be incremented accordingly

Parameters

[in]	recordType	The type of the new group record
[in]	multicastAddress	The multicast address of the new group record
[in]	sourceAddresses	A vector containing all the source addresses of the new group record
[in]	index	The index to add the new group address at

Returns: The method constructs a new group record, adds it to the IGMPv3 report message and returns a pointer to the new message. If something went wrong in creating or adding the new group record a nullptr value is returned and an appropriate error message is printed to log

◆ getFirstGroupRecord()

igmpv3_group_record* pcpp::IgmpV3ReportLayer::getFirstGroupRecord ( ) const

Returns: A pointer to the first group record or nullptr if no group records exist. Notice the return value is a pointer to the real data, so changes in the return value will affect the packet data

◆ getGroupRecordCount()

uint16_t pcpp::IgmpV3ReportLayer::getGroupRecordCount ( ) const

Returns: The number of group records in this message (as extracted from the igmpv3_report_header::numOfGroupRecords field)

◆ getHeaderLen()

size_t pcpp::IgmpV3ReportLayer::getHeaderLen ( ) const

inlineoverridevirtual

Returns: The message size in bytes which include the size of the basic header + the size of the group record list

Reimplemented from pcpp::IgmpLayer.

◆ getNextGroupRecord()

igmpv3_group_record* pcpp::IgmpV3ReportLayer::getNextGroupRecord ( igmpv3_group_record * groupRecord ) const

Get the group record that comes next to a given group record. If "groupRecord" is nullptr then nullptr will be returned. If "groupRecord" is the last group record or if it is out of layer bounds nullptr will be returned also. Notice the return value is a pointer to the real data casted to igmpv3_group_record type (as opposed to a copy of the option data). So changes in the return value will affect the packet data

Parameters

[in] groupRecord The group record to start searching from

Returns: The next group record or nullptr if "groupRecord" is nullptr, last or out of layer bounds

◆ getReportHeader()

igmpv3_report_header* pcpp::IgmpV3ReportLayer::getReportHeader ( ) const

inline

Get a pointer to the raw IGMPv3 membership report header. Notice this points directly to the data, so every change will change the actual packet data

Returns: A pointer to the igmpv3_report_header

◆ isDataValid()

static bool pcpp::IgmpV3ReportLayer::isDataValid	(	uint8_t const *	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 IGMPv3 Report layer
[in]	dataLen	The length of the byte stream

Returns: True if the data is valid and can represent an IGMPv3 Report layer

◆ removeAllGroupRecords()

bool pcpp::IgmpV3ReportLayer::removeAllGroupRecords ( )

Remove all group records in the message. The igmpv3_report_header::numOfGroupRecords field will be set to 0

Returns: True if all group records were cleared successfully or false otherwise. If false is returned an appropriate error message will be printed to log

◆ removeGroupRecordAtIndex()

bool pcpp::IgmpV3ReportLayer::removeGroupRecordAtIndex ( int index )

Remove a group record at a certain index. The igmpv3_report_header::numOfGroupRecords field will be decremented accordingly

Parameters

[in] index The index of the group record to be removed

Returns: True if group record was removed successfully or false otherwise. If false is returned an appropriate error message will be printed to log

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IgmpV3ReportLayer()

Member Function Documentation

◆ addGroupRecord()

◆ addGroupRecordAtIndex()

◆ getFirstGroupRecord()

◆ getGroupRecordCount()

◆ getHeaderLen()

◆ getNextGroupRecord()

◆ getReportHeader()

◆ isDataValid()

◆ removeAllGroupRecords()

◆ removeGroupRecordAtIndex()