timer.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of oveRTOS.
 */
 
#pragma once
 
#include <ove/timer.h>
#include <ove/types.hpp>
#include <ove/error.hpp>
 
#ifdef CONFIG_OVE_TIMER
 
namespace ove
{
 
template <typename F>
concept TimerCallback = std::convertible_to<F, ove_timer_fn>;
 
class Timer
{
      public:
    template <typename F>
    Timer(F callback, void *user_data, uint32_t period_ms, bool one_shot = false)
        requires TimerCallback<F>
    {
#ifdef CONFIG_OVE_ZERO_HEAP
        int err = ove_timer_init(&handle_, &storage_, callback, user_data, period_ms,
                     one_shot ? 1 : 0);
#else
        int err = ove_timer_create(&handle_, callback, user_data, period_ms,
                       one_shot ? 1 : 0);
#endif
        OVE_STATIC_INIT_ASSERT(err == OVE_OK);
    }
 
    ~Timer() noexcept
    {
        if (!handle_)
            return;
#ifdef CONFIG_OVE_ZERO_HEAP
        ove_timer_deinit(handle_);
#else
        ove_timer_destroy(handle_);
#endif
    }
 
    Timer(const Timer &) = delete;
    Timer &operator=(const Timer &) = delete;
 
#ifdef CONFIG_OVE_ZERO_HEAP
    Timer(Timer &&) = delete;
    Timer &operator=(Timer &&) = delete;
#else
    Timer(Timer &&other) noexcept : handle_(other.handle_)
    {
        other.handle_ = nullptr;
    }
 
    Timer &operator=(Timer &&other) noexcept
    {
        if (this != &other) {
            if (handle_)
                ove_timer_destroy(handle_);
            handle_ = other.handle_;
            other.handle_ = nullptr;
        }
        return *this;
    }
#endif
 
    [[nodiscard]] Result<void> start() noexcept
    {
        return from_rc(ove_timer_start(handle_));
    }
 
    [[nodiscard]] Result<void> stop() noexcept
    {
        return from_rc(ove_timer_stop(handle_));
    }
 
    [[nodiscard]] Result<void> reset() noexcept
    {
        return from_rc(ove_timer_reset(handle_));
    }
 
    bool valid() const
    {
        return handle_ != nullptr;
    }
 
    ove_timer_t handle() const
    {
        return handle_;
    }
 
      private:
    ove_timer_t handle_ = nullptr;
#ifdef CONFIG_OVE_ZERO_HEAP
    ove_timer_storage_t storage_ = {};
#endif
};
 
} /* namespace ove */
 
#endif /* CONFIG_OVE_TIMER */