From 040eee1aa49b49df4698d83a05af57c220127fd1 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 4 May 2024 13:36:04 +0200 Subject: Adding upstream version 2.2.0. Signed-off-by: Daniel Baumann --- src/bin/netconf/unix_control_socket.h | 89 +++++++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 src/bin/netconf/unix_control_socket.h (limited to 'src/bin/netconf/unix_control_socket.h') diff --git a/src/bin/netconf/unix_control_socket.h b/src/bin/netconf/unix_control_socket.h new file mode 100644 index 0000000..538ae17 --- /dev/null +++ b/src/bin/netconf/unix_control_socket.h @@ -0,0 +1,89 @@ +// Copyright (C) 2018-2021 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/. + +/// @file unix_control_socket.h +/// Contains declarations for UNIX control socket communication. + +#ifndef UNIX_CONTROL_SOCKET_H +#define UNIX_CONTROL_SOCKET_H + +#include + +namespace isc { +namespace netconf { + +/// @brief Class for control socket communication over UNIX socket. +/// +/// This class is the derived class for control socket communication +/// over UNIX sockets. +/// This class implements config-get, config-test and config-set. +class UnixControlSocket : public ControlSocketBase { +public: + + /// @brief Constructor. + /// + /// @param ctrl_sock The control socket configuration. + UnixControlSocket(CfgControlSocketPtr ctrl_sock); + + /// @brief Destructor (does nothing). + virtual ~UnixControlSocket() = default; + + /// @brief Get configuration. + /// + /// Call config-get over the control socket. + /// + /// @param service The target service (ignored). + /// @return The JSON element answer of config-get. + /// @throw ControlSocketError when a communication error occurs. + virtual data::ConstElementPtr configGet(const std::string& service); + + /// @brief Test configuration. + /// + /// Call config-test over the control socket. + /// + /// @param service The target service (ignored). + /// @param config The configuration to test. + /// @return The JSON element answer of config-test. + /// @throw ControlSocketError when a communication error occurs. + virtual data::ConstElementPtr configTest(data::ConstElementPtr config, + const std::string& service); + + /// @brief Set configuration. + /// + /// Call config-set over the control socket. + /// + /// @param config The configuration to set. + /// @param service The target service (ignored). + /// @return The JSON element answer of config-set. + /// @throw ControlSocketError when a communication error occurs. + virtual data::ConstElementPtr configSet(data::ConstElementPtr config, + const std::string& service); + +private: + /// @brief Perform the actual communication. + /// + /// @note This method is synchronous, i.e. it blocks until it finishes + /// and returns. + /// + /// @param command The command to send. + /// @return The answer. + data::ConstElementPtr sendCommand(data::ConstElementPtr command); +}; + +/// @brief Type definition for the pointer to the @c UnixControlSocket. +typedef boost::shared_ptr UnixControlSocketPtr; + +/// @brief Factory template specialization for unix control sockets. +/// +/// @param ctrl_sock The control socket configuration. +/// @return A pointer to a unix control socket communication object. +template <> ControlSocketBasePtr +createControlSocket(CfgControlSocketPtr ctrl_sock); + +} // namespace netconf +} // namespace isc + +#endif // UNIX_CONTROL_SOCKET_H -- cgit v1.2.3