ALPAKA/rtos2-utils
1
0
Fork 0
mirror of https://git.intern.spaceteamaachen.de/ALPAKA/rtos2-utils.git synced 2025-08-06 19:17:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Full Doxygen documentation

Browse Source
This commit is contained in:
@CarlWachter
2024-01-06 16:30:30 +01:00
parent b30d47413b
commit b4b214a756
10 changed files with 137 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
include/sta/rtos/event.hpp
View File

@@ -9,12 +9,18 @@
#include <cmsis_os2.h>
#include <sta/event.hpp>
/**
* @defgroup STA_RTOS_EVENT Event
* @ingroup STA_RTOS_API
* @brief CMSIS RTOS2 Event.
*/
namespace sta
{
/**
* @brief Implementation of Event using CMSIS RTOS2.
*
* @ingroup STA_RTOS_API
* @ingroup STA_RTOS_EVENT
*/
class RtosEvent : public Event
{
@@ -22,9 +28,30 @@ namespace sta
RtosEvent();
~RtosEvent();
/**
* @brief Set given flags for the event.
*/
void set(uint32_t flags) override;
/**
* @brief Clear given flags for the event.
*/
void clear(uint32_t flags) override;
/**
* @brief Get current flags for the event.
*
* @return Current flags.
*/
uint32_t get() override;
/**
* @brief Wait for any of the given flags to be set.
*
* @param flags Flags to wait for.
* @param timeout Timeout in milliseconds.
* @return Event flags before clearing or error code if highest bit set.
*/
uint32_t wait(uint32_t flags, uint32_t timeout = osWaitForever) override;
private: