openthread_sys

Function otBackboneRouterMulticastListenerGetNext

Source
pub unsafe extern "C" fn otBackboneRouterMulticastListenerGetNext(
    aInstance: *mut otInstance,
    aIterator: *mut otBackboneRouterMulticastListenerIterator,
    aListenerInfo: *mut otBackboneRouterMulticastListenerInfo,
) -> otError
Expand description

Gets the next Multicast Listener info (using an iterator).

@param[in] aInstance A pointer to an OpenThread instance. @param[in,out] aIterator A pointer to the iterator. On success the iterator will be updated to point to next Multicast Listener. To get the first entry the iterator should be set to OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT. @param[out] aListenerInfo A pointer to an otBackboneRouterMulticastListenerInfo where information of next Multicast Listener is placed (on success).

@retval OT_ERROR_NONE Successfully found the next Multicast Listener info (@p aListenerInfo was successfully updated). @retval OT_ERROR_NOT_FOUND No subsequent Multicast Listener info was found.

@sa otBackboneRouterMulticastListenerClear @sa otBackboneRouterMulticastListenerAdd