BaseModule.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2014-2016 Leosac
 
    This file is part of Leosac.
 
    Leosac is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    Leosac 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 Affero General Public License for more details.
 
    You should have received a copy of the GNU Affero General Public License
    along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include "LeosacFwd.hpp"
#include "core/config/ConfigChecker.hpp"
#include "core/config/ConfigManager.hpp"
#include "tools/ThreadUtils.hpp"
#include "tools/log.hpp"
#include <boost/property_tree/ptree.hpp>
#include <zmqpp/zmqpp.hpp>
 
extern "C" {
const char *get_module_name();
}
 
namespace Leosac
{
namespace Module
{
template <typename UserModule>
bool start_module_helper(zmqpp::socket *pipe, boost::property_tree::ptree cfg,
                         zmqpp::context &zmq_ctx, CoreUtilsPtr utils)
{
    try
    {
        set_thread_name(fmt::format("mod_{}", get_module_name()));
        UserModule module(zmq_ctx, pipe, cfg, utils);
        INFO("Module " << get_module_name()
                       << " is now initialized. Thread id = " << Leosac::gettid());
        pipe->send(zmqpp::signal::ok);
 
        module.run();
    }
    catch (const std::exception &e)
    {
        ERROR("An exception occurred in module code. Leosac will terminate."
              << std::endl
              << "Message: " << e.what() << std::endl
              << "Module: " << get_module_name());
        std::terminate();
    }
    INFO("Module " << get_module_name() << " has now terminated.");
    return true;
}
 
class BaseModule
{
  public:
    BaseModule(zmqpp::context &ctx, zmqpp::socket *pipe,
               const boost::property_tree::ptree &cfg, CoreUtilsPtr utils);
 
    virtual ~BaseModule() = default;
 
    virtual void run();
 
  protected:
    virtual void handle_pipe();
 
    virtual void handle_control();
 
    virtual void dump_additional_config(zmqpp::message *out) const;
 
    void dump_config(ConfigManager::ConfigFormat fmt, zmqpp::message *out_msg) const;
 
    void config_check(const std::string &obj_name, Leosac::Hardware::DeviceClass type);
 
    void config_check(const std::string &obj_name);
 
    zmqpp::context &ctx_;
 
    zmqpp::socket &pipe_;
 
    boost::property_tree::ptree config_;
 
    CoreUtilsPtr utils_;
 
    bool is_running_;
 
    zmqpp::socket control_;
 
    zmqpp::reactor reactor_;
 
    std::string name_;
};
}
}