event_loop_interface.h

Go to the documentation of this file.

/* * NRP Core - Backend infrastructure to synchronize simulations
 *
 * Copyright 2020-2023 NRP Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * This project has received funding from the European Union’s Horizon 2020
 * Framework Programme for Research and Innovation under the Specific Grant
 * Agreement No. 945539 (Human Brain Project SGA3).
 */
 
#ifndef EVENT_LOOP_INTERFACE_H
#define EVENT_LOOP_INTERFACE_H
 
#include <chrono>
#include <thread>
#include <future>
 
#include <nlohmann/json.hpp>
 
class EventLoopInterface
{
    public:
 
        virtual ~EventLoopInterface() = default;
 
        EventLoopInterface() = delete;
 
        EventLoopInterface(std::chrono::milliseconds timestep, std::chrono::milliseconds timestepThres);
 
        virtual void initialize();
 
        void runLoopOnce(const std::chrono::time_point<std::chrono::steady_clock>& startTime);
 
        void runLoop(std::chrono::milliseconds timeout);
 
        void runLoopAsync(std::chrono::milliseconds timeout = std::chrono::milliseconds(0), bool doInit = false);
 
        void stopLoop();
 
        void shutdown();
 
        bool isRunning();
 
        void waitForLoopEnd();
 
    protected:
 
        virtual void initializeCB() = 0;
 
        virtual void runLoopCB() = 0;
 
        virtual void shutdownCB() = 0;
 
        std::chrono::milliseconds _timestep;
        std::chrono::milliseconds _timestepThres;
        std::chrono::milliseconds _currentTime = std::chrono::milliseconds(0);
        unsigned long _iterations = 0L;
 
        bool isRunningNotAsync();
 
    private:
 
        std::future<void> _runFuture;
        std::atomic<bool> _doRun;
        bool _isInitialized = false;
};
 
 
#endif // EVENT_LOOP_INTERFACE_H