Function openthread_sys::otPlatUdpJoinMulticastGroup

source ·

pub unsafe extern "C" fn otPlatUdpJoinMulticastGroup(
    aUdpSocket: *mut otUdpSocket,
    aNetifIdentifier: otNetifIdentifier,
    aAddress: *const otIp6Address
) -> otError

Expand description

Configures the UDP socket to join a UDP multicast group.

Note: only available when OPENTHREAD_CONFIG_PLATFORM_UDP_ENABLE is used.

@param[in] aUdpSocket A pointer to the UDP socket. @param[in] aNetifIdentifier The network interface identifier. @param[in] aAddress The UDP multicast group address.

@retval OT_ERROR_NONE Successfully joined the multicast group. @retval OT_ERROR_FAILED Failed to join the multicast group.