Timer.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "CeresEngine/Foundation/Function.hpp"
#include "CeresEngine/Foundation/SmartPtr.hpp"
#include "CeresEngine/Foundation/Threading/ExecutionContext.hpp"
 
#include <asio/high_resolution_timer.hpp>
 
namespace CeresEngine {
 
    template<typename Clock> class TTimer {
    public:
        using TimePoint = typename Clock::time_point;
        using Duration = typename Clock::duration;
        using Callback = UniqueFunction<void(TTimer*)>;
 
    private:
        using TimerType = asio::basic_waitable_timer<Clock, asio::wait_traits<Clock>, AnyIOExecutor>;
        TimerType mTimer;
 
        Callback mCallback;
        bool mRepeating = false;
        Duration mRepeatInterval;
 
    public:
        //        TTimer(ExecutionContext& context, Duration duration, Callback callback, bool repeating = false);
        TTimer(AnyIOExecutor executor, Duration duration, Callback callback, bool repeating = false);
 
        //        TTimer(ExecutionContext& context, Duration duration, Callback callback, Duration repeatInterval);
        TTimer(AnyIOExecutor executor, Duration duration, Callback callback, Duration repeatInterval);
 
        //        TTimer(ExecutionContext& context, TimePoint timePoint, Callback callback);
        TTimer(AnyIOExecutor executor, TimePoint timePoint, Callback callback);
 
        //        TTimer(ExecutionContext& context, TimePoint timePoint, Callback callback, Duration repeatInterval);
        TTimer(AnyIOExecutor executor, TimePoint timePoint, Callback callback, Duration repeatInterval);
 
        ~TTimer() noexcept;
 
    private:
        void setup(Duration duration);
        void setup(TimePoint timePoint);
        void fire();
 
    public:
        //        /// \copydoc TTimer(ExecutionContext&, Duration, Callback, bool)
        //        static UPtr<TTimer> create(ExecutionContext& context, Duration duration, Callback callback, bool repeating = false);
 
        static UPtr<TTimer> create(AnyIOExecutor executor, Duration duration, Callback callback, bool repeating = false);
 
        //        /// \copydoc TTimer(ExecutionContext&, Duration, Callback, Duration);
        //        static UPtr<TTimer> create(ExecutionContext& context, Duration duration, Callback callback, Duration repeatInterval);
 
        static UPtr<TTimer> create(AnyIOExecutor executor, Duration duration, Callback callback, Duration repeatInterval);
 
        //        /// \copydoc TTimer(ExecutionContext&, TimePoint, Callback);
        //        static UPtr<TTimer> create(ExecutionContext& context, TimePoint timePoint, Callback callback);
 
        static UPtr<TTimer> create(AnyIOExecutor executor, TimePoint timePoint, Callback callback);
 
        //        /// \copydoc TTimer(ExecutionContext&, TimePoint, Callback, Duration);
        //        static UPtr<TTimer> create(ExecutionContext& context, TimePoint timePoint, Callback callback, Duration repeatInterval);
 
        static UPtr<TTimer> create(AnyIOExecutor executor, TimePoint timePoint, Callback callback, Duration repeatInterval);
    };
 
    extern template class TTimer<std::chrono::system_clock>;
    extern template class TTimer<std::chrono::steady_clock>;
    extern template class TTimer<std::chrono::high_resolution_clock>;
 
    using Timer = TTimer<std::chrono::system_clock>;
    using SteadyTimer = TTimer<std::chrono::steady_clock>;
    using HighResolutionTimer = TTimer<std::chrono::high_resolution_clock>;
 
} // namespace CeresEngine