TCPIP_IGMP_ExcludeSource Function

C

TCPIP_IGMP_RESULT TCPIP_IGMP_ExcludeSource(
    UDP_SOCKET socket, 
    TCPIP_NET_HANDLE hNet, 
    IPV4_ADDR mcastAddress, 
    IPV4_ADDR sourceAddress
);

Description

This function performs the unsubscription of a UDP socket to multicast traffic from one source.

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 unsubscribe from. It has to be within the IANA specified multicast address range.
sourceAddressdestination source for which the socket wants to unsubscribe from.

Returns

  • TCPIP_IGMP_OK if - if operation succeeded, otherwise an error code appears.

Remarks

The function supports ASM functionality. It is a shortcut to TCPIP_IGMP_Subscribe(EXCLUDE, 1 source).