mirror of
https://git.intern.spaceteamaachen.de/ALPAKA/rtos2-utils.git
synced 2025-08-06 11:07:34 +00:00
Rename to STA RTOS
This commit is contained in:
67
include/sta/rtos/queue.hpp
Normal file
67
include/sta/rtos/queue.hpp
Normal file
@@ -0,0 +1,67 @@
|
||||
/**
|
||||
* @file
|
||||
* @brief RTOS queue implementation.
|
||||
*/
|
||||
#ifndef STA_RTOS_QUEUE_HPP
|
||||
#define STA_RTOS_QUEUE_HPP
|
||||
|
||||
#include <cmsis_os2.h>
|
||||
|
||||
#include <cstdint>
|
||||
|
||||
|
||||
namespace sta
|
||||
{
|
||||
/**
|
||||
* @brief Interface object for using CMSIS RTOS2 queues.
|
||||
*
|
||||
* @tparam Message type
|
||||
*
|
||||
* @ingroup STA_RTOS_API
|
||||
*/
|
||||
template <typename T>
|
||||
class RTOSQueue
|
||||
{
|
||||
public:
|
||||
using Message = T; /**< Queue message type */
|
||||
|
||||
public:
|
||||
/**
|
||||
* @param handle CMSIS RTOS2 queue handle
|
||||
*/
|
||||
RTOSQueue(osMessageQueueId_t * handle);
|
||||
|
||||
/**
|
||||
* @brief Place message in queue.
|
||||
*
|
||||
* @param msg Message object
|
||||
* @param timeout Timeout
|
||||
* @return True on success
|
||||
*/
|
||||
bool put(const Message & msg, uint32_t timeout = osWaitForever);
|
||||
/**
|
||||
* @brief Take message from queue.
|
||||
*
|
||||
* @param[out] outMsg Message object destination
|
||||
* @param timeout Timeout
|
||||
* @return True on success
|
||||
*/
|
||||
bool get(Message * outMsg, uint32_t timeout = osWaitForever);
|
||||
|
||||
/**
|
||||
* @brief Get number of messages in queue.
|
||||
*
|
||||
* @return Number of messages in queue
|
||||
*/
|
||||
uint32_t available() const;
|
||||
|
||||
private:
|
||||
osMessageQueueId_t * handle_; /**< CMSIS RTOS2 queue handle */
|
||||
};
|
||||
} // namespace sta
|
||||
|
||||
|
||||
#include <sta/rtos/queue.tpp>
|
||||
|
||||
|
||||
#endif // STA_RTOS_QUEUE_HPP
|
Reference in New Issue
Block a user