zephyr::raw

Function k_mbox_get

source
pub unsafe extern "C" fn k_mbox_get(
    mbox: *mut k_mbox,
    rx_msg: *mut k_mbox_msg,
    buffer: *mut c_void,
    timeout: k_timeout_t,
) -> i32
Expand description

@brief Receive a mailbox message.

This routine receives a message from @a mbox, then optionally retrieves its data and disposes of the message.

@param mbox Address of the mailbox. @param rx_msg Address of the receive message descriptor. @param buffer Address of the buffer to receive data, or NULL to defer data retrieval and message disposal until later. @param timeout Waiting period for a message to be received, or one of the special values K_NO_WAIT and K_FOREVER.

@retval 0 Message received. @retval -ENOMSG Returned without waiting. @retval -EAGAIN Waiting period timed out.