IGMP host. More...
#include "core/net.h"#include "ipv4/ipv4.h"#include "igmp/igmp_host.h"#include "igmp/igmp_host_misc.h"#include "debug.h"Go to the source code of this file.
Macros | |
| #define | TRACE_LEVEL IGMP_TRACE_LEVEL |
Functions | |
| error_t | igmpHostInit (NetInterface *interface) |
| IGMP host initialization. More... | |
| error_t | igmpHostJoinGroup (NetInterface *interface, Ipv4FilterEntry *entry) |
| Join the specified host group. More... | |
| error_t | igmpHostLeaveGroup (NetInterface *interface, Ipv4FilterEntry *entry) |
| Leave the specified host group. More... | |
| void | igmpHostTick (NetInterface *interface) |
| IGMP timer handler. More... | |
| void | igmpHostLinkChangeEvent (NetInterface *interface) |
| Callback function for link change event. More... | |
Detailed Description
IGMP host.
License
SPDX-License-Identifier: GPL-2.0-or-later
Copyright (C) 2010-2024 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.
Description
IGMP is used by IP hosts to report their multicast group memberships to routers. Refer to the following RFCs for complete details:
- RFC 1112: Host Extensions for IP Multicasting
- RFC 2236: Internet Group Management Protocol, Version 2
- RFC 3376: Internet Group Management Protocol, Version 3
- Version
- 2.4.0
Definition in file igmp_host.c.
Macro Definition Documentation
◆ TRACE_LEVEL
| #define TRACE_LEVEL IGMP_TRACE_LEVEL |
Definition at line 40 of file igmp_host.c.
Function Documentation
◆ igmpHostInit()
| error_t igmpHostInit | ( | NetInterface * | interface | ) |
IGMP host initialization.
- Parameters
-
[in] interface Underlying network interface
- Returns
- Error code
Definition at line 59 of file igmp_host.c.
◆ igmpHostJoinGroup()
| error_t igmpHostJoinGroup | ( | NetInterface * | interface, |
| Ipv4FilterEntry * | entry | ||
| ) |
Join the specified host group.
- Parameters
-
[in] interface Underlying network interface [in] entry IPv4 filter entry identifying the host group to join
- Returns
- Error code
Definition at line 87 of file igmp_host.c.
◆ igmpHostLeaveGroup()
| error_t igmpHostLeaveGroup | ( | NetInterface * | interface, |
| Ipv4FilterEntry * | entry | ||
| ) |
Leave the specified host group.
- Parameters
-
[in] interface Underlying network interface [in] entry IPv4 filter entry identifying the host group to leave
- Returns
- Error code
Definition at line 137 of file igmp_host.c.
◆ igmpHostLinkChangeEvent()
| void igmpHostLinkChangeEvent | ( | NetInterface * | interface | ) |
Callback function for link change event.
- Parameters
-
[in] interface Underlying network interface
Definition at line 223 of file igmp_host.c.
◆ igmpHostTick()
| void igmpHostTick | ( | 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 166 of file igmp_host.c.