Scheduler.hpp

Go to the documentation of this file.

/**********************************************************************************/
/* This file is part of Berserk Engine project                                    */
/* https://github.com/EgorOrachyov/Berserk                                        */
/**********************************************************************************/
/* MIT License                                                                    */
/*                                                                                */
/* Copyright (c) 2018 - 2021 Egor Orachyov                                        */
/*                                                                                */
/* Permission is hereby granted, free of charge, to any person obtaining a copy   */
/* of this software and associated documentation files (the "Software"), to deal  */
/* in the Software without restriction, including without limitation the rights   */
/* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell      */
/* copies of the Software, and to permit persons to whom the Software is          */
/* furnished to do so, subject to the following conditions:                       */
/*                                                                                */
/* The above copyright notice and this permission notice shall be included in all */
/* copies or substantial portions of the Software.                                */
/*                                                                                */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR     */
/* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,       */
/* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE    */
/* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER         */
/* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  */
/* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  */
/* SOFTWARE.                                                                      */
/**********************************************************************************/
 
#ifndef BERSERK_SCHEDULER_HPP
#define BERSERK_SCHEDULER_HPP
 
#include <core/Config.hpp>
#include <core/Typedefs.hpp>
 
#include <functional>
#include <mutex>
#include <unordered_map>
#include <vector>
 
BRK_NS_BEGIN
 
class Scheduler final {
public:
    using ScheduledFunc = std::function<void(float)>;
    using PerformFunc = std::function<void()>;
    using Handle = size_t;
    static const uint32 REPEAT_FOREVER = 0x7fffffff;
 
    BRK_API Handle Schedule(ScheduledFunc func, float interval, uint32 repeat = 0, float delay = 0.0f, bool paused = false);
 
    BRK_API Handle ScheduleOnce(ScheduledFunc func, float delay, bool paused = false);
 
    BRK_API Handle ScheduleUpdate(ScheduledFunc func, uint32 repeat = 0, float delay = 0.0f, bool paused = false);
 
    BRK_API void ScheduleOnGameThread(PerformFunc func);
 
    BRK_API void Cancel(Handle handle);
 
    BRK_API void Pause(Handle handle);
 
    BRK_API void Resume(Handle handle);
 
private:
    friend class Engine;
 
    struct Scheduled {
        float elapsed = 0.0f;
        float interval = 0.0f;
        float delay = 0.0f;
        uint32 repeat = 0;
        uint32 executed = 0;
        bool paused = false;
        bool forever = false;
        bool update = false;
        bool delayed = false;
        ScheduledFunc callback;
    };
 
    void Update(float dt);
    bool Exhausted(Scheduled &scheduled) const;
    Handle GetNext();
 
private:
    std::unordered_map<Handle, Scheduled> mScheduled;
 
    std::vector<Handle> mPendingRemove;
    std::vector<std::pair<Handle, Scheduled>> mPendingAdd;
    std::vector<std::pair<Handle, bool>> mPendingPause;
 
    std::vector<PerformFunc> mToPerform;
    std::vector<PerformFunc> mToPerformExec;
    mutable std::mutex mMutex;
 
    Handle mNextHandle = 0;
 
    float mTimeScale = 1.0f;
};
 
BRK_NS_END
 
#endif//BERSERK_SCHEDULER_HPP