NetMLDP_HostGrpJoin

Join a MLDP Multicast host group.

Files

net_mldp.h/net_mldp.c

Prototype


          CPU_BOOLEAN  NetMLDP_HostGrpJoin (NET_IF_NBR      if_nbr,
                                            NET_IPv6_ADDR  *p_addr_grp,
                                            NET_ERR        *p_err);

Arguments

if_nbr

Interface number to join host group.

p_addr_grp

Pointer to IPv6 address of host group to join.

p_err

Pointer to variable that will receive the return error code from this function:

NET_MLDP_ERR_NONE
NET_MLDP_ERR_INVALID_ADDR_GRP
NET_MLDP_ERR_HOST_GRP_NONE_AVAIL
NET_MLDP_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

MLDP module is automatically enabled when using IPv6. Therefore, NET_IPv6_CFG_EN must be enabled to use MLDP module (see section Network Stack Configuration).

Notes / Warnings

None.