TCPIP_IGMP_Leave Function

C

TCPIP_IGMP_RESULT TCPIP_IGMP_Leave(
    UDP_SOCKET socket, 
    TCPIP_NET_HANDLE hNet, 
    IPV4_ADDR mcastAddress
);

Description

This function performs the IGMPv2 style "leave" operation for a UDP socket from a multicast group.

Preconditions

The IGMP module must be initialized.

Parameters

ParametersDescription
socketThe UDP multicast socket.
hNetInterface handle. if hNet == 0, then the default interface will be used.
mcastAddressThe multicast address to join to. It has to be within the IANA specified multicast address range.

Returns

  • TCPIP_IGMP_OK - if operation succeeded. An error code otherwise.

Remarks

The function is an ASM helper. It is a shortcut to TCPIP_IGMP_Subscribe(EXCLUDE, {}).