I just wanted to know if these APIs are guaranteed thread safe by the ThreadX RTOS?
/** @} */
/*****************************************************************************/
/** @addtogroup queues Queues
* @ingroup rtos
*
* Queue management functionss
*
*
* @{
*/
/*****************************************************************************/
/** Initialises a queue
*
* Initialises a FIFO queue
*
* @param queue : a pointer to the queue handle to be initialised
* @param name : a text string name for the queue (NULL is allowed)
* @param message_size : size in bytes of objects that will be held in the queue
* @param number_of_messages : depth of the queue - i.e. max number of objects in the queue
*
* @return WICED_SUCCESS : on success.
* @return WICED_ERROR : if an error occurred
*/
wiced_result_t wiced_rtos_init_queue( wiced_queue_t* queue, const char* name, uint32_t message_size, uint32_t number_of_messages );
/** Pushes an object onto a queue
*
* Pushes an object onto a queue
*
* @param queue : a pointer to the queue handle
* @param message : the object to be added to the queue. Size is assumed to be
* the size specified in @ref wiced_rtos_init_queue
* @param timeout_ms: the number of milliseconds to wait before returning
*
* @return WICED_SUCCESS : on success.
* @return WICED_ERROR : if an error or timeout occurred
*/
wiced_result_t wiced_rtos_push_to_queue( wiced_queue_t* queue, void* message, uint32_t timeout_ms );
/** Pops an object off a queue
*
* Pops an object off a queue
*
* @param queue : a pointer to the queue handle
* @param message : pointer to a buffer that will receive the object being
* popped off the queue. Size is assumed to be
* the size specified in @ref wiced_rtos_init_queue , hence
* you must ensure the buffer is long enough or memory
* corruption will result
* @param timeout_ms: the number of milliseconds to wait before returning
*
* @return WICED_SUCCESS : on success.
* @return WICED_ERROR : if an error or timeout occurred
*/
wiced_result_t wiced_rtos_pop_from_queue( wiced_queue_t* queue, void* message, uint32_t timeout_ms );
/** De-initialise a queue
*
* Deletes a queue created with @ref wiced_rtos_init_queue
*
* @param queue : a pointer to the queue handle
*
* @return WICED_SUCCESS : on success.
* @return WICED_ERROR : if an error occurred
*/
wiced_result_t wiced_rtos_deinit_queue( wiced_queue_t* queue );
/** Check if a queue is empty
*
* @param queue : a pointer to the queue handle
*
* @return WICED_SUCCESS : queue is empty.
* @return WICED_ERROR : queue is not empty.
*/
wiced_result_t wiced_rtos_is_queue_empty( wiced_queue_t* queue );
/** Check if a queue is full
*
* @param queue : a pointer to the queue handle
*
* @return WICED_SUCCESS : queue is full.
* @return WICED_ERROR : queue is not full.
*/
wiced_result_t wiced_rtos_is_queue_full( wiced_queue_t* queue );
/** Get the queue occupancy
*
* @param queue : a pointer to the queue handle
* @param count : pointer to integer for storing occupancy count
*
* @return WICED_SUCCESS : on success.
* @return WICED_ERROR : if an error occurred
*/
wiced_result_t wiced_rtos_get_queue_occupancy( wiced_queue_t* queue, uint32_t *count );
