nest_engine_server_nrp_client.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 NEST_ENGINE_SERVER_NRP_CLIENT_H
#define NEST_ENGINE_SERVER_NRP_CLIENT_H
 
#include "nrp_nest_server_engine/config/nest_server_config.h"
#include "nrp_general_library/engine_interfaces/engine_client_interface.h"
#include "nrp_general_library/plugin_system/plugin.h"
 
#include <future>
#include <string>
#include <unistd.h>
 
class NestEngineServerNRPClient
        : public EngineClient<NestEngineServerNRPClient, NestServerConfigConst::EngineSchema>
{
        static constexpr size_t _killWait = 10;
 
        static constexpr uint16_t PortSearchStart = 5000;
 
    public:
        NestEngineServerNRPClient(nlohmann::json &config, ProcessLauncherInterface::unique_ptr &&launcher);
        virtual ~NestEngineServerNRPClient() override;
 
        virtual void initialize() override;
        virtual void reset() override;
        virtual void shutdown() override;
 
        SimulationTime runLoopStepCallback(SimulationTime timeStep) override;
 
        virtual void sendDataPacksToEngine(const datapacks_set_t & datapacksArray) override;
 
        virtual const std::vector<std::string> engineProcStartParams() const override;
 
        using population_mapping_t = std::map<std::string, std::string>;
 
        using get_connection_population_mapping_t = std::map<std::string, std::pair<std::string,std::string> >;
 
        virtual datapacks_vector_t getDataPacksFromEngine(const datapack_identifiers_set_t &datapackIdentifiers) override;
 
    private:
 
        std::future<bool> _runStepThread;
 
        population_mapping_t _populations;
 
        float _simulationResolution = 0.0f;
 
        std::string _serverAddress;
 
        get_connection_population_mapping_t _getConnectionsPopulationToArgs;
 
        bool runStepFcn(SimulationTime timestep);
 
        std::string serverAddress() const;
 
        const std::string & getDataPackIdList(const std::string & datapackName) const;
 
};
 
using NestEngineServerNRPClientLauncher = NestEngineServerNRPClient::EngineLauncher<NestServerConfigConst::EngineType>;
 
 
CREATE_NRP_ENGINE_LAUNCHER(NestEngineServerNRPClientLauncher);
 
 
#endif // NEST_ENGINE_SERVER_NRP_CLIENT_H