NetIGMP_HostGrpLeave

Owned by Former user (Deleted)
Last updated: Dec 08, 2020 by WES Admin
1 min read

Leave a host group.

Files

net_igmp.h/net_igmp.c

Prototype

          void NetIGMP_HostGrpLeave (NET_IF_NBR      if_nbr,
                                     NET_IPv4_ADDR   addr_grp,
                                     NET_ERR        *p_err);

Arguments

if_nbr

Interface number to leave host group.

addr_grp

IPv4 address of host group to leave.

p_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_ERR_FAULT_LOCK_ACQUIRE

Returned Value

DEF_OK,

if host group successfully left.

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.