unix_command_mgr.h

Go to the documentation of this file.

// Copyright (C) 2015-2024 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 UNIX_COMMAND_MGR_H
#define UNIX_COMMAND_MGR_H
 
#include <asiolink/io_service.h>
#include <cc/data.h>
#include <exceptions/exceptions.h>
#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>
 
namespace isc {
namespace config {
 
class BadSocketInfo : public Exception {
public:
    BadSocketInfo(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { };
};
 
class SocketError : public Exception {
public:
    SocketError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) { };
};
 
class UnixCommandMgrImpl;
 
class UnixCommandMgr : public boost::noncopyable {
public:
 
    static UnixCommandMgr& instance();
 
    void setIOService(const asiolink::IOServicePtr& io_service);
 
    void setConnectionTimeout(const long timeout);
 
    void addExternalSockets(bool use_external = true);
 
    void
    openCommandSocket(const isc::data::ConstElementPtr& socket_info);
 
    void closeCommandSocket();
 
    int getControlSocketFD();
 
private:
 
    UnixCommandMgr();
 
    boost::shared_ptr<UnixCommandMgrImpl> impl_;
};
 
} // end of isc::config namespace
} // end of isc namespace
#endif