launch_command.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 LAUNCH_COMMAND_H
#define LAUNCH_COMMAND_H
 
#include "nrp_general_library/utils/fixed_string.h"
#include "nrp_general_library/utils/ptr_templates.h"
#include <nlohmann/json.hpp>
 
#include <string>
#include <vector>
 
class LaunchCommandInterface
        : public PtrTemplates<LaunchCommandInterface>
{
    public:
        enum ENGINE_RUNNING_STATUS
        {
            UNKNOWN = -1,
            RUNNING,
            STOPPED
        };
 
        LaunchCommandInterface() = default;
        virtual ~LaunchCommandInterface() = default;
 
        virtual pid_t launchProcess(const nlohmann::json &launcherConfig, const std::string& procCmd,
                                    const std::vector<std::string> &envParams,
                                    const std::vector<std::string> &startParams,
                                    bool appendParentEnv = true, int logFD = -1) = 0;
 
        virtual pid_t stopProcess(unsigned int killWait) = 0;
 
        virtual ENGINE_RUNNING_STATUS getProcessStatus()
        {   return UNKNOWN; }
 
        virtual std::string_view launchType() const = 0;
 
};
 
template<const char* LAUNCH_COMMAND>
class LaunchCommand
        : public LaunchCommandInterface
{
    public:
        static constexpr auto LaunchType = LAUNCH_COMMAND;
 
        std::string_view launchType() const override final
        {   return LaunchType;  }
};
 
 
#endif // LAUNCH_COMMAND_H