OsEventFlags.h

Go to the documentation of this file.

 
#ifndef OS_EVENT_FLAGS_H_
#define OS_EVENT_FLAGS_H_
 
#include <cstdint>
#include <climits>
#include "OsAbstraction.h"
#include "OsUtility.h"
 
enum class WaitMode : uint8_t {
    Any,  
    All,  
};
 
template <size_t kReserved = 1>
class OsEventFlags {
public:
    explicit OsEventFlags(const char* groupName) noexcept
        : name_(groupName)
    {
        created_ = os_event_flags_create_ex(group_, name_);
    }
 
    OsEventFlags(const OsEventFlags&) = delete;
    OsEventFlags& operator=(const OsEventFlags&) = delete;
 
    ~OsEventFlags() noexcept
    {
        if (created_) {
            os_event_flags_delete_ex(group_);
        }
    }
 
    [[nodiscard]] bool IsValid() const noexcept { return created_; }
 
    bool Set(uint32_t bits) noexcept
    {
        if (!created_) return false;
        return os_event_flags_set_ex(group_, static_cast<OS_Ulong>(bits));
    }
 
    bool Clear(uint32_t bits) noexcept
    {
        if (!created_) return false;
        return os_event_flags_clear_ex(group_, static_cast<OS_Ulong>(bits));
    }
 
    bool Wait(uint32_t bits, WaitMode mode, uint32_t timeout_ms,
              uint32_t& actual_bits) noexcept
    {
        actual_bits = 0;
        if (!created_) return false;
        OS_Ulong actual = 0;
        const OS_Uint option = (mode == WaitMode::All)
                                   ? static_cast<OS_Uint>(OS_AND)
                                   : static_cast<OS_Uint>(OS_OR);
        const bool ok = os_event_flags_get_ex(group_, static_cast<OS_Ulong>(bits),
                                              option, actual, ToTicks(timeout_ms));
        actual_bits = static_cast<uint32_t>(actual);
        return ok;
    }
 
private:
    static OS_Ulong ToTicks(uint32_t timeout_ms) noexcept
    {
        return (timeout_ms == UINT32_MAX)
            ? static_cast<OS_Ulong>(OS_WAIT_FOREVER)
            : static_cast<OS_Ulong>(os_convert_msec_to_delay_ticks(timeout_ms));
    }
 
    const char*   name_;
    bool          created_{false};
    OS_EventGroup group_{};
};
 
#endif /* OS_EVENT_FLAGS_H_ */