riot_sys

Function event_wait_timeout_ztimer

Source
pub unsafe extern "C" fn event_wait_timeout_ztimer(
    queue: *mut event_queue_t,
    clock: *mut ztimer_clock_t,
    timeout: u32,
) -> *mut event_t
Expand description

@brief Get next event from event queue, blocking until timeout expires

This function is the same as event_wait_timeout() with the difference that it uses ztimer instead of xtimer as timer backend.

@pre The queue must have a waiter (i.e. it should have been claimed, or initialized using @ref event_queue_init, @ref event_queues_init)

@param[in] queue queue to query for an event @param[in] clock ztimer clock to use @param[in] timeout maximum time to wait for an event, time unit depends on the used ztimer clock

@return pointer to next event if event was taken from the queue @return NULL if timeout expired before an event was posted