Leave a host group.
Files
net_igmp.h/net_igmp.c
Prototype
Arguments
if_nbr
Interface number to leave host group.
addr_grp
IP address of host group to leave.
err
Pointer to variable that will receive the return error code from this function:
NET_IGMP_ERR_NONE
NET_IGMP_ERR_HOST_GRP_NOT_FOUND
NET_ERR_INIT_INCOMPLETE
NET_OS_ERR_LOCK
Returned Value
DEF_OK,
if host group successfully left.
DEF_FAIL,
otherwise.
Required Configuration
Available only if NET_IP_CFG_MULTICAST_SEL is configured for transmit and receive multicasting (see section D-9-2).
Notes / Warnings
addr_grp must be in host-order.