5.13.0.0R1
Software Development Kit
IGMP multicast

Functions

wiced_result_t wiced_multicast_join (wiced_interface_t interface, const wiced_ip_address_t *address)
 
wiced_result_t wiced_multicast_leave (wiced_interface_t interface, const wiced_ip_address_t *address)
 

Detailed Description

Functions for joining/leaving IGMP (Internet Group Management Protocol) groups

Function Documentation

wiced_result_t wiced_multicast_join ( wiced_interface_t  interface,
const wiced_ip_address_t *  address 
)

Joins an IGMP group

Joins an IGMP multicast group, allowing reception of packets being sent to the group.

Parameters
[in]interface: The interface (AP or STA) which should be used to join the group
[in]address: The IP address of the multicast group which should be joined.
Returns
wiced_result_t
wiced_result_t wiced_multicast_leave ( wiced_interface_t  interface,
const wiced_ip_address_t *  address 
)

Leaves an IGMP group

Leaves an IGMP multicast group, stopping reception of packets being sent to the group.

Parameters
[in]interface: The interface (AP or STA) which should was used to join the group
[in]address: The IP address of the multicast group which should be left.
Returns
wiced_result_t