Timer.hpp

// SPDX-FileCopyrightText: 2025 Vincent Leroy
// SPDX-License-Identifier: MIT
//
// This file is part of dfx.
//
// Licensed under the MIT License. See the LICENSE file in the project root
// for full license information.
 
#pragma once
 
// Standard includes
#include <chrono>
#include <functional>
 
// Project includes
#include "PollerFd.hpp"
#include <dfx-utilities/EnumString.hpp>
#include <dfx-utilities/PrivateState.hpp>
 
namespace dfx::FdWatch
{
class Poller;

class Timer
{
    DFX_PRIVATE_STATE(Timer, DFX_FDWATCH_LOGGER())
 
public:
    enum class Mode : bool
    {
        SingleShot, 
        Repeating,  
    };
 
public:
    using Callback = std::move_only_function<void ()>;
 
public:
    Timer();

    Timer(Poller & poller, std::chrono::milliseconds timeout, Callback cb, Mode mode = Mode::SingleShot);
 
    DFX_PRIVATE_STATE_DECLARE_RULE_OF_5(Timer);

    std::chrono::milliseconds timeout() const noexcept;

    std::chrono::milliseconds remainingTime() const;

    Mode mode() const noexcept;

    bool isSingleShot() const noexcept;

    bool isRepeating() const noexcept;

    bool isActive() const noexcept;
 
public:
    void attach(Poller & poller, std::chrono::milliseconds timeout, Callback cb, Mode mode = Mode::SingleShot);

    void start();

    void start(std::chrono::milliseconds timeout);

    void stop();

    void close() noexcept;
};
} // !namespace dfx::FdWatch
 
DECLARE_ENUM_STRING_FUNCTIONS(dfx::FdWatch::Timer::Mode);