Definitions common to IGMP host, router and snooping switch. More...

#include "core/net.h"

Macros
#define	IGMP_TICK_INTERVAL 1000

#define	IGMP_ROBUSTNESS_VARIABLE 2

#define	IGMP_QUERY_INTERVAL 125000

#define	IGMP_QUERY_RESPONSE_INTERVAL 10000

#define	IGMP_GROUP_MEMBERSHIP_INTERVAL

#define	IGMP_OTHER_QUERIER_PRESENT_INTERVAL

#define	IGMP_STARTUP_QUERY_INTERVAL (IGMP_QUERY_INTERVAL / 4)

#define	IGMP_STARTUP_QUERY_COUNT IGMP_ROBUSTNESS_VARIABLE

#define	IGMP_LAST_MEMBER_QUERY_INTERVAL 1000

#define	IGMP_LAST_MEMBER_QUERY_COUNT IGMP_ROBUSTNESS_VARIABLE

#define	IGMP_LAST_MEMBER_QUERY_TIME

#define	IGMP_UNSOLICITED_REPORT_INTERVAL 10000

#define	IGMP_V1_ROUTER_PRESENT_TIMEOUT 400000

#define	IGMP_V1_MAX_RESPONSE_TIME 10000

#define	IGMP_TTL 1

#define	IGMP_ALL_SYSTEMS_ADDR IPV4_ADDR(224, 0, 0, 1)

#define	IGMP_ALL_ROUTERS_ADDR IPV4_ADDR(224, 0, 0, 2)

Enumerations
enum	IgmpType { IGMP_TYPE_MEMBERSHIP_QUERY = 0x11, IGMP_TYPE_MEMBERSHIP_REPORT_V1 = 0x12, IGMP_TYPE_MEMBERSHIP_REPORT_V2 = 0x16, IGMP_TYPE_LEAVE_GROUP = 0x17, IGMP_TYPE_MEMBERSHIP_REPORT_V3 = 0x22 }
	IGMP message type. More...

Functions
error_t	igmpInit (NetInterface *interface)
	IGMP initialization. More...

void	igmpTick (NetInterface *interface)
	IGMP timer handler. More...

void	igmpLinkChangeEvent (NetInterface *interface)
	Callback function for link change event. More...

error_t	igmpSendMessage (NetInterface interface, Ipv4Addr destAddr, const IgmpMessage message, size_t length)
	Send IGMP message. More...

void	igmpProcessMessage (NetInterface interface, const Ipv4PseudoHeader pseudoHeader, const NetBuffer buffer, size_t offset, const NetRxAncillary ancillary)
	Process incoming IGMP message. More...

void	igmpDumpMessage (const IgmpMessage *message)
	Dump IGMP message for debugging purpose. More...

Variables
typedef	__packed_struct
	General IGMP message format. More...

uint8_t	maxRespTime

uint16_t	checksum

Ipv4Addr	groupAddr

	IgmpMessage

systime_t	igmpTickCounter

Detailed Description

Definitions common to IGMP host, router and snooping switch.

License

SPDX-License-Identifier: GPL-2.0-or-later

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.3.0

Definition in file igmp_common.h.

Macro Definition Documentation

◆ IGMP_ALL_ROUTERS_ADDR

#define IGMP_ALL_ROUTERS_ADDR IPV4_ADDR(224, 0, 0, 2)

Definition at line 132 of file igmp_common.h.

◆ IGMP_ALL_SYSTEMS_ADDR

#define IGMP_ALL_SYSTEMS_ADDR IPV4_ADDR(224, 0, 0, 1)

Definition at line 130 of file igmp_common.h.

◆ IGMP_GROUP_MEMBERSHIP_INTERVAL

#define IGMP_GROUP_MEMBERSHIP_INTERVAL

Value:

((IGMP_ROBUSTNESS_VARIABLE * \

IGMP_QUERY_INTERVAL) + IGMP_QUERY_RESPONSE_INTERVAL)

Definition at line 66 of file igmp_common.h.

◆ IGMP_LAST_MEMBER_QUERY_COUNT

#define IGMP_LAST_MEMBER_QUERY_COUNT IGMP_ROBUSTNESS_VARIABLE

Definition at line 96 of file igmp_common.h.

◆ IGMP_LAST_MEMBER_QUERY_INTERVAL

#define IGMP_LAST_MEMBER_QUERY_INTERVAL 1000

Definition at line 89 of file igmp_common.h.

◆ IGMP_LAST_MEMBER_QUERY_TIME

#define IGMP_LAST_MEMBER_QUERY_TIME

Value:

(IGMP_LAST_MEMBER_QUERY_COUNT * \

IGMP_LAST_MEMBER_QUERY_INTERVAL)

Definition at line 102 of file igmp_common.h.

◆ IGMP_OTHER_QUERIER_PRESENT_INTERVAL

#define IGMP_OTHER_QUERIER_PRESENT_INTERVAL

Value:

((IGMP_ROBUSTNESS_VARIABLE * \

IGMP_QUERY_INTERVAL) + (IGMP_QUERY_RESPONSE_INTERVAL / 2))

Definition at line 70 of file igmp_common.h.

◆ IGMP_QUERY_INTERVAL

#define IGMP_QUERY_INTERVAL 125000

Definition at line 53 of file igmp_common.h.

◆ IGMP_QUERY_RESPONSE_INTERVAL

#define IGMP_QUERY_RESPONSE_INTERVAL 10000

Definition at line 60 of file igmp_common.h.

◆ IGMP_ROBUSTNESS_VARIABLE

#define IGMP_ROBUSTNESS_VARIABLE 2

Definition at line 46 of file igmp_common.h.

◆ IGMP_STARTUP_QUERY_COUNT

#define IGMP_STARTUP_QUERY_COUNT IGMP_ROBUSTNESS_VARIABLE

Definition at line 82 of file igmp_common.h.

◆ IGMP_STARTUP_QUERY_INTERVAL

#define IGMP_STARTUP_QUERY_INTERVAL (IGMP_QUERY_INTERVAL / 4)

Definition at line 75 of file igmp_common.h.

◆ IGMP_TICK_INTERVAL

#define IGMP_TICK_INTERVAL 1000

Definition at line 39 of file igmp_common.h.

◆ IGMP_TTL

#define IGMP_TTL 1

Definition at line 127 of file igmp_common.h.

◆ IGMP_UNSOLICITED_REPORT_INTERVAL

#define IGMP_UNSOLICITED_REPORT_INTERVAL 10000

Definition at line 107 of file igmp_common.h.

◆ IGMP_V1_MAX_RESPONSE_TIME

#define IGMP_V1_MAX_RESPONSE_TIME 10000

Definition at line 121 of file igmp_common.h.

◆ IGMP_V1_ROUTER_PRESENT_TIMEOUT

#define IGMP_V1_ROUTER_PRESENT_TIMEOUT 400000

Definition at line 114 of file igmp_common.h.

Enumeration Type Documentation

◆ IgmpType

enum IgmpType

IGMP message type.

Enumerator
IGMP_TYPE_MEMBERSHIP_QUERY
IGMP_TYPE_MEMBERSHIP_REPORT_V1
IGMP_TYPE_MEMBERSHIP_REPORT_V2
IGMP_TYPE_LEAVE_GROUP
IGMP_TYPE_MEMBERSHIP_REPORT_V3

Definition at line 144 of file igmp_common.h.

Function Documentation

◆ igmpDumpMessage()

void igmpDumpMessage ( const IgmpMessage * message )

Dump IGMP message for debugging purpose.

Parameters

[in] message Pointer to the IGMP message

Definition at line 339 of file igmp_common.c.

◆ igmpInit()

error_t igmpInit ( NetInterface * interface )

IGMP initialization.

Parameters

[in] interface Underlying network interface

Returns: Error code

Definition at line 59 of file igmp_common.c.

◆ igmpLinkChangeEvent()

void igmpLinkChangeEvent ( NetInterface * interface )

Callback function for link change event.

Parameters

[in] interface Underlying network interface

Definition at line 123 of file igmp_common.c.

◆ igmpProcessMessage()

void igmpProcessMessage	(	NetInterface *	interface,
		const Ipv4PseudoHeader *	pseudoHeader,
		const NetBuffer *	buffer,
		size_t	offset,
		const NetRxAncillary *	ancillary
	)

Process incoming IGMP message.

Parameters

[in]	interface	Underlying network interface
[in]	pseudoHeader	IPv4 pseudo header
[in]	buffer	Multi-part buffer containing the incoming IGMP message
[in]	offset	Offset to the first byte of the IGMP message
[in]	ancillary	Additional options passed to the stack along with the packet

Definition at line 259 of file igmp_common.c.

◆ igmpSendMessage()

error_t igmpSendMessage	(	NetInterface *	interface,
		Ipv4Addr	destAddr,
		const IgmpMessage *	message,
		size_t	length
	)

Send IGMP message.

Parameters

[in]	interface	Underlying network interface
[in]	destAddr	Destination IP address
[in]	message	Pointer to the IGMP message
[in]	length	Length of the IGMP message, in bytes

Returns: Error code

Definition at line 141 of file igmp_common.c.

◆ igmpTick()

void igmpTick ( NetInterface * interface )

IGMP timer handler.

This routine must be periodically called by the TCP/IP stack to handle IGMP related timers

Parameters

[in] interface Underlying network interface

Definition at line 91 of file igmp_common.c.

Variable Documentation

◆ __packed_struct

typedef __packed_struct

Initial value:

{

uint8_t type

General IGMP message format.

Definition at line 164 of file igmp_common.h.

◆ checksum

uint16_t checksum

Definition at line 168 of file igmp_common.h.

◆ groupAddr

Ipv4Addr groupAddr

Definition at line 169 of file igmp_common.h.

◆ IgmpMessage

IgmpMessage

Definition at line 170 of file igmp_common.h.

◆ igmpTickCounter

systime_t igmpTickCounter

extern

Definition at line 50 of file igmp_common.c.

◆ maxRespTime

uint8_t maxRespTime

Definition at line 167 of file igmp_common.h.

Macros

Enumerations

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ IGMP_ALL_ROUTERS_ADDR

◆ IGMP_ALL_SYSTEMS_ADDR

◆ IGMP_GROUP_MEMBERSHIP_INTERVAL

◆ IGMP_LAST_MEMBER_QUERY_COUNT

◆ IGMP_LAST_MEMBER_QUERY_INTERVAL

◆ IGMP_LAST_MEMBER_QUERY_TIME

◆ IGMP_OTHER_QUERIER_PRESENT_INTERVAL

◆ IGMP_QUERY_INTERVAL

◆ IGMP_QUERY_RESPONSE_INTERVAL

◆ IGMP_ROBUSTNESS_VARIABLE

◆ IGMP_STARTUP_QUERY_COUNT

◆ IGMP_STARTUP_QUERY_INTERVAL

◆ IGMP_TICK_INTERVAL

◆ IGMP_TTL

◆ IGMP_UNSOLICITED_REPORT_INTERVAL

◆ IGMP_V1_MAX_RESPONSE_TIME

◆ IGMP_V1_ROUTER_PRESENT_TIMEOUT

Enumeration Type Documentation

◆ IgmpType

Function Documentation

◆ igmpDumpMessage()

◆ igmpInit()

◆ igmpLinkChangeEvent()

◆ igmpProcessMessage()

◆ igmpSendMessage()

◆ igmpTick()

Variable Documentation

◆ __packed_struct

◆ checksum

◆ groupAddr

◆ IgmpMessage

◆ igmpTickCounter

◆ maxRespTime