d_process.h

Go to the documentation of this file.

// Copyright (C) 2013-2020 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#ifndef D_PROCESS_H
#define D_PROCESS_H

#include <asiolink/io_service.h>
#include <cc/data.h>
#include <process/d_cfg_mgr.h>

#include <boost/shared_ptr.hpp>

#include <exceptions/exceptions.h>

#include <atomic>

namespace isc {
namespace process {

class DProcessBaseError : public isc::Exception {
public:
    DProcessBaseError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { };
};

static const std::string VERSION_GET_COMMAND("version-get");

static const std::string BUILD_REPORT_COMMAND("build-report");

static const std::string CONFIG_GET_COMMAND("config-get");

static const std::string CONFIG_WRITE_COMMAND("config-write");

static const std::string CONFIG_TEST_COMMAND("config-test");

static const std::string CONFIG_RELOAD_COMMAND("config-reload");

static const std::string CONFIG_SET_COMMAND("config-set");

static const std::string SERVER_TAG_GET_COMMAND("server-tag-get");

static const std::string SHUT_DOWN_COMMAND("shutdown");

static const std::string STATUS_GET_COMMAND("status-get");

static const int COMMAND_SUCCESS = 0;

static const int COMMAND_ERROR = 1;

static const int COMMAND_INVALID = 2;

class DProcessBase {
public:
    DProcessBase(const char* app_name, asiolink::IOServicePtr io_service,
                 DCfgMgrBasePtr cfg_mgr)
        : app_name_(app_name), io_service_(io_service), shut_down_flag_(false),
        cfg_mgr_(cfg_mgr) {
        if (!io_service_) {
            isc_throw (DProcessBaseError, "IO Service cannot be null");
        }

        if (!cfg_mgr_) {
            isc_throw (DProcessBaseError, "CfgMgr cannot be null");
        }
    };

    virtual void init() = 0;

    virtual void run() = 0;

    virtual isc::data::ConstElementPtr
    shutdown(isc::data::ConstElementPtr args) = 0;

    virtual isc::data::ConstElementPtr
    configure(isc::data::ConstElementPtr config_set,
              bool check_only = false) = 0;

    virtual ~DProcessBase(){};

    bool shouldShutdown() const {
        return (shut_down_flag_);
    }

    void setShutdownFlag(bool value) {
        shut_down_flag_ = value;
    }

    const std::string getAppName() const {
        return (app_name_);
    }

    asiolink::IOServicePtr& getIoService() {
        return (io_service_);
    }

    void stopIOService() {
        io_service_->stop();
    }

    DCfgMgrBasePtr& getCfgMgr() {
        return (cfg_mgr_);
    }

private:
    std::string app_name_;

    asiolink::IOServicePtr io_service_;

    std::atomic<bool> shut_down_flag_;

    DCfgMgrBasePtr cfg_mgr_;
};

typedef boost::shared_ptr<DProcessBase> DProcessBasePtr;

}; // namespace isc::process
}; // namespace isc

#endif