ModuleController.h

Go to the documentation of this file.

/*
 * i6engine
 * Copyright (2016) Daniel Bonrath, Michael Baer, All rights reserved.
 *
 * This file is part of i6engine; i6engine is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef __I6ENGINE_CORE_MODULECONTROLLER_H__
#define __I6ENGINE_CORE_MODULECONTROLLER_H__

#include <condition_variable>
#include <cstdint>
#include <mutex>
#include <string>

#include "i6engine/utils/i6eSystemParameters.h"

#include "i6engine/core/messaging/MessageSubscriber.h"

namespace boost {
        class thread;
} /* boost */

namespace i6e {
namespace core {

        class EngineCoreController;
        class MessagingController;
        class SubSystemController;
        class Timer;

        enum class Subsystem;

        enum class SubsystemType {
                Ticking,
                Waiting
        };

        class ISIXE_CORE_API ModuleController : public MessageSubscriber {
                friend class SubSystemController;

        public:
                ModuleController(Subsystem sub);

                virtual ~ModuleController();

                void startThreadTicking(const uint32_t lngFrameTime);

                void startThreadWaiting(const std::set<Subsystem> & waitingFor);

                inline uint32_t getFrameTime() const {
                        return _frameTime;
                }

                inline void setController(SubSystemController * ssc, EngineCoreController * ecc, MessagingController * mc) {
                        _subsystemController = ssc;
                        _ctrl = ecc;
                        _messagingController = mc;
                }

                virtual void OnThreadStart() = 0;

                virtual void Tick() = 0;

                virtual void ShutDown() = 0;

                Subsystem getSubsystem() const {
                        return _subsystem;
                }

        protected:
                Subsystem _subsystem;

                uint32_t _frameTime;

                MessagingController * _messagingController;

                void processMessages() override;

        private:
                inline void setTimer(Timer * ptrTimer) {
                        _ptrTimer = ptrTimer;
                }

                inline Timer * getTimer() const {
                        return _ptrTimer;
                }

                void runLoopTicking();
                void runLoopWaiting();

                EngineCoreController * _ctrl;

                Timer * _ptrTimer;

                bool _isRunning;

                SubSystemController * _subsystemController;

                SubsystemType _type;

                std::set<Subsystem> _waitingSubsystems;

                std::set<Subsystem> _notifiedSubsystems;

                std::map<Subsystem, std::vector<Message::Ptr>> _waitingMessages;

                std::vector<Message::Ptr> _messages;

                mutable std::mutex _lock;
                std::condition_variable _conditionVariable;

#ifdef ISIXE_WITH_PROFILING

                uint64_t _lastTime;

                uint16_t _fps;

                uint16_t _expectedFps;
#endif /* ISIXE_WITH_PROFILING */

                inline void setRunning(bool b) {
                        _isRunning = b;
                }

                inline bool getRunning() const {
                        return _isRunning;
                }

                void deliverMessageInternal(const ReceivedMessagePtr & msg) override;

                void stop() {
                        std::unique_lock<std::mutex> ul(_lock);
                        _conditionVariable.notify_one();
                }

                ModuleController(const ModuleController &) = delete;

                ModuleController & operator=(const ModuleController &) = delete;
        };

} /* namespace core */
} /* namespace i6e */

#endif /* __I6ENGINE_CORE_MODULECONTROLLER_H__ */