Function openthread_sys::otBackboneRouterMulticastListenerAdd

source ·

pub unsafe extern "C" fn otBackboneRouterMulticastListenerAdd(
    aInstance: *mut otInstance,
    aAddress: *const otIp6Address,
    aTimeout: u32
) -> otError

Expand description

Adds a Multicast Listener with a timeout value, in seconds.

Pass 0 to use the default MLR timeout.

Available when OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE, and OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE are enabled.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aAddress The Multicast Listener address. @param[in] aTimeout The timeout (in seconds) of the Multicast Listener, or 0 to use the default MLR timeout.

@retval OT_ERROR_NONE If the Multicast Listener was successfully added. @retval OT_ERROR_INVALID_ARGS If the Multicast Listener address was invalid. @retval OT_ERROR_NO_BUFS No space available to save the Multicast Listener.

@sa otBackboneRouterMulticastListenerClear @sa otBackboneRouterMulticastListenerGetNext