igmp_common.c File Reference

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

#include "core/net.h"
#include "igmp/igmp_host.h"
#include "igmp/igmp_host_misc.h"
#include "igmp/igmp_router.h"
#include "igmp/igmp_router_misc.h"
#include "igmp/igmp_snooping.h"
#include "igmp/igmp_snooping_misc.h"
#include "igmp/igmp_common.h"
#include "debug.h"

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   IGMP_TRACE_LEVEL

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, Ipv4PseudoHeader *pseudoHeader, const NetBuffer *buffer, size_t offset, NetRxAncillary *ancillary)
	Process incoming IGMP message. More...
void	igmpDumpMessage (const IgmpMessage *message)
	Dump IGMP message for debugging purpose. More...

Variables
systime_t	igmpTickCounter

Detailed Description

Definitions common to IGMP host, router and snooping switch.

License

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

Copyright (C) 2010-2023 Oryx Embedded SARL. All rights reserved.

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

Definition in file igmp_common.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   IGMP_TRACE_LEVEL

Definition at line 32 of file igmp_common.c.

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,
		Ipv4PseudoHeader *	pseudoHeader,
		const NetBuffer *	buffer,
		size_t	offset,
		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

igmpTickCounter

systime_t igmpTickCounter

Definition at line 50 of file igmp_common.c.