igmp_host_misc.h File Reference

Helper functions for IGMP host. More...

#include "core/net.h"
#include "igmp/igmp_host.h"

Go to the source code of this file.

Functions

error_t igmpHostSendMembershipReport (NetInterface *interface, Ipv4Addr ipAddr)
 Send Membership Report message. More...
 
error_t igmpHostSendLeaveGroup (NetInterface *interface, Ipv4Addr ipAddr)
 Send Leave Group message. More...
 
void igmpHostProcessMessage (NetInterface *interface, const IgmpMessage *message, size_t length)
 Process incoming IGMP message. More...
 
void igmpHostProcessMembershipQuery (NetInterface *interface, const IgmpMessage *message, size_t length)
 Process incoming Membership Query message. More...
 
void igmpHostProcessMembershipReport (NetInterface *interface, const IgmpMessage *message, size_t length)
 Process incoming Membership Report message. More...
 

Detailed Description

Helper functions for 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.

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

Definition in file igmp_host_misc.h.

Function Documentation

◆ igmpHostProcessMembershipQuery()

void igmpHostProcessMembershipQuery ( NetInterface interface,
const IgmpMessage message,
size_t  length 
)

Process incoming Membership Query message.

Parameters
[in]interfaceUnderlying network interface
[in]messagePointer to the incoming IGMP message
[in]lengthLength of the IGMP message, in bytes

Definition at line 174 of file igmp_host_misc.c.

◆ igmpHostProcessMembershipReport()

void igmpHostProcessMembershipReport ( NetInterface interface,
const IgmpMessage message,
size_t  length 
)

Process incoming Membership Report message.

Parameters
[in]interfaceUnderlying network interface
[in]messagePointer to the incoming IGMP message
[in]lengthLength of the IGMP message, in bytes

Definition at line 275 of file igmp_host_misc.c.

◆ igmpHostProcessMessage()

void igmpHostProcessMessage ( NetInterface interface,
const IgmpMessage message,
size_t  length 
)

Process incoming IGMP message.

Parameters
[in]interfaceUnderlying network interface
[in]messagePointer to the incoming IGMP message
[in]lengthLength of the IGMP message, in bytes

Definition at line 145 of file igmp_host_misc.c.

◆ igmpHostSendLeaveGroup()

error_t igmpHostSendLeaveGroup ( NetInterface interface,
Ipv4Addr  ipAddr 
)

Send Leave Group message.

Parameters
[in]interfaceUnderlying network interface
[in]ipAddrIPv4 address specifying the group address being left
Returns
Error code

Definition at line 99 of file igmp_host_misc.c.

◆ igmpHostSendMembershipReport()

error_t igmpHostSendMembershipReport ( NetInterface interface,
Ipv4Addr  ipAddr 
)

Send Membership Report message.

Parameters
[in]interfaceUnderlying network interface
[in]ipAddrIPv4 address specifying the group address
Returns
Error code

Definition at line 52 of file igmp_host_misc.c.