IGMP API

IGMP (Internet Group Management Protocol). More...

Data Structures
struct	igmp_param
	IGMP parameters. More...

Functions
static int	net_ipv4_igmp_join (struct net_if *iface, const struct net_in_addr *addr, const struct igmp_param *param)
	Join a given multicast group.
static int	net_ipv4_igmp_leave (struct net_if *iface, const struct net_in_addr *addr)
	Leave a given multicast group.

Detailed Description

IGMP (Internet Group Management Protocol).

Since

2.6

Version

0.8.0

Function Documentation

net_ipv4_igmp_join()

int net_ipv4_igmp_join ( struct net_if * iface, const struct net_in_addr * addr, const struct igmp_param * param )

inlinestatic

#include <zephyr/net/igmp.h>

Join a given multicast group.

Parameters

iface	Network interface where join message is sent
addr	Multicast group to join
param	Optional parameters

Return values

0	If multicast address was registered and joined successfully.
-ENETDOWN	If multicast address was registered but not joined yet due to network interface being down. The address will be joined when interface is up again. This is non-fatal return code, the caller should still release the address with net_ipv4_igmp_leave() if no longer needed.
Other	Any other error should be considered fatal, multicast address was not registered for the interface.

net_ipv4_igmp_leave()

int net_ipv4_igmp_leave ( struct net_if * iface, const struct net_in_addr * addr )

inlinestatic

#include <zephyr/net/igmp.h>

Leave a given multicast group.

Parameters

iface	Network interface where leave message is sent
addr	Multicast group to leave

Returns

Return 0 if leaving is done, <0 otherwise.