Join a host group.
Files
net_igmp.h/net_igmp.c
Prototype
Arguments
if_nbr
Interface number to join host group.
addr_grp
IPv4 address of host group to join.
p_err
Pointer to variable that will receive the return error code from this function:
NET_IGMP_ERR_NONE
NET_IGMP_ERR_INVALID_ADDR_GRP
NET_IGMP_ERR_HOST_GRP_NONE_AVAIL
NET_IGMP_ERR_HOST_GRP_INVALID_TYPE
NET_IF_ERR_INVALID_IF
NET_INIT_ERR_NOT_COMPLETED
NET_ERR_FAULT_LOCK_ACQUIRE
Returned Value
DEF_OK,
if host group successfully joined.
DEF_FAIL,
otherwise.
Required Configuration
Available only if NET_MCAST_CFG_IPv4_RX_EN is enabled (see section Network Stack Configuration).
IGMP is the protocol used for multicast communication with IPv4. Therefore, IGMP can be used only if NET_IPv4_CFG_EN is also enabled (see section Network Stack Configuration).
Notes / Warnings
addr_grp must be in host-order.