ALPAKA/sta-core
1
0
Fork 0
mirror of https://git.intern.spaceteamaachen.de/ALPAKA/sta-core.git synced 2025-06-11 17:16:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request 'Added peek() method to Event interface' (#38) from feat/event-peek into main

Browse Source 
Reviewed-on: https://git.intern.spaceteamaachen.de/ALPAKA/sta-core/pulls/38
Reviewed-by: carlwachter <carlwachter@noreply.git.intern.spaceteamaachen.de>
This commit is contained in:
carlwachter 2024-12-02 17:23:40 +00:00
commit 1558821e72
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/sta/event.hpp
View File

@ -35,12 +35,19 @@ namespace sta
*/ */
virtual uint32_t get() = 0; virtual uint32_t get() = 0;
/** /**
* @brief Wait until event flag is set. Timeout default to forever. * @brief Wait until event flags are set and clears them afterwards. Timeout default to forever.
* *
* @param flags flag nr. to wait for. * @param flags flags to wait for.
* @param timeout timeout in ms., default to forever. * @param timeout timeout in ms., default to forever.
*/ */
virtual uint32_t wait(uint32_t flags, uint32_t timeout = osWaitForever) = 0; virtual uint32_t wait(uint32_t flags, uint32_t timeout = osWaitForever) = 0;
/**
* @brief Wait until event flags are set without clearing them afterwards. Timeout default to forever.
*
* @param flags flags to wait for.
* @param timeout timeout in ms., default to forever.
*/
virtual uint32_t peek(uint32_t flags, uint32_t timeout = osWaitForever) = 0;
}; };
} // namespace sta } // namespace sta