control_socket.h

Go to the documentation of this file.

// Copyright (C) 2018-2025 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 CONTROL_SOCKET_H
#define CONTROL_SOCKET_H
 
#include <exceptions/exceptions.h>
#include <netconf/netconf_config.h>
 
namespace isc {
namespace netconf {
 
class ControlSocketError : public isc::Exception {
public:
    ControlSocketError(const char* file, size_t line, const char* what)
        : isc::Exception(file, line, what) {
    }
};  // ControlSocketError
 
class ControlSocketBase {
public:
    ControlSocketBase(CfgControlSocketPtr ctrl_sock) : socket_cfg_(ctrl_sock) {
        if (!ctrl_sock) {
            isc_throw(ControlSocketError, "ControlSocket constructor called "
                                          "with a null configuration");
        }
    }
 
    virtual ~ControlSocketBase() = default;
 
    CfgControlSocket::Type getType() const {
        return (socket_cfg_->getType());
    }
 
    const std::string getName() const {
        return (socket_cfg_->getName());
    }
 
    const isc::http::Url getUrl() const {
        return (socket_cfg_->getUrl());
    }
 
    virtual data::ConstElementPtr configGet(const std::string& service) = 0;
 
    virtual data::ConstElementPtr configTest(data::ElementPtr config,
                                             const std::string& service) = 0;
 
    virtual data::ConstElementPtr configSet(data::ElementPtr config,
                                            const std::string& service) = 0;
 
    CfgControlSocketPtr socket_cfg_;
};  // ControlSocketBase
 
using ControlSocketBasePtr = std::shared_ptr<ControlSocketBase>;
 
template <CfgControlSocket::Type TYPE>
ControlSocketBasePtr
createControlSocket(CfgControlSocketPtr ctrl_sock) {
    isc_throw(NotImplemented, "not specialized createControlSocket");
}
 
ControlSocketBasePtr
controlSocketFactory(CfgControlSocketPtr ctrl_sock);
 
}  // namespace netconf
}  // namespace isc
 
#endif  // CONTROL_SOCKET_H