Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

NetIGMP_HostGrpJoin()

Join a host group.

Files

net_igmp.h/net_igmp.c

Prototype

Arguments

if_nbr

Interface number to join host group.

addr_grp

IP address of host group to join.

perr

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_ERR_INIT_INCOMPLETE
NET_OS_ERR_LOCK

Returned Value

DEF_OK,

if host group successfully joined.

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.