Network Multicast#

Functions#

sl_status_t
sl_net_join_multicast_address(sl_net_interface_t interface, const sl_ip_address_t *ip_address)

Enable multicast for the given IP address.

sl_status_t
sl_net_leave_multicast_address(sl_net_interface_t interface, const sl_ip_address_t *ip_address)

Disable multicast for the given IP address.

Function Documentation#

sl_net_join_multicast_address#

sl_status_t sl_net_join_multicast_address (sl_net_interface_t interface, const sl_ip_address_t * ip_address)

Enable multicast for the given IP address.

Parameters
[in]interface

Interface identified by sl_net_interface_t.

[in]ip_address

Multicast IP address of type sl_ip_address_t.

This function enables multicast for the specified IP address on the given interface. It allows the interface to receive/send multicast packets sent to the specified IP address.

Users can use sendto and recvfrom socket APIs to send and receive data.

  • Pre-conditions:

Returns


Definition at line 467 of file components/service/network_manager/inc/sl_net.h

sl_net_leave_multicast_address#

sl_status_t sl_net_leave_multicast_address (sl_net_interface_t interface, const sl_ip_address_t * ip_address)

Disable multicast for the given IP address.

Parameters
[in]interface

Interface identified by sl_net_interface_t.

[in]ip_address

Multicast IP address of type sl_ip_address_t.

This function disables multicast for the specified IP address on the given interface. It prevents the interface from receiving/sending multicast packets sent to the specified IP address.

  • Pre-conditions:

Returns


Definition at line 488 of file components/service/network_manager/inc/sl_net.h