riot_sys::bindgen

Function os_mqueue_init

Source
pub unsafe extern "C" fn os_mqueue_init(
    mq: *mut os_mqueue,
    ev_cb: ble_npl_event_fn,
    arg: *mut c_void,
) -> c_int
Expand description

Initializes an mqueue. An mqueue is a queue of mbufs that ties to a particular task’s event queue. Mqueues form a helper API around a common paradigm: wait on an event queue until at least one packet is available, then process a queue of packets.

When mbufs are available on the queue, an event OS_EVENT_T_MQUEUE_DATA will be posted to the task’s mbuf queue.

@param mq The mqueue to initialize @param ev_cb The callback to associate with the mqeueue event. Typically, this callback pulls each packet off the mqueue and processes them. @param arg The argument to associate with the mqueue event.

@return 0 on success, non-zero on failure.