netconf.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 NETCONF_H
#define NETCONF_H
 
#include <netconf/control_socket.h>
#include <netconf/http_control_socket.h>
#include <netconf/netconf_cfg_mgr.h>
#include <netconf/stdout_control_socket.h>
#include <netconf/unix_control_socket.h>
 
#include <map>
 
#ifdef WDEPRECATED_LITERAL_OPERATOR_FLAG_SUPPORTED
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-literal-operator"
#endif
// #include <sysrepo-cpp/Changes.hpp>  // Will be required on newer sysrepo-cpp
#include <sysrepo-cpp/Session.hpp>
// #include <sysrepo-cpp/Subscription.hpp>  // Will be required on newer sysrepo-cpp
#ifdef WDEPRECATED_LITERAL_OPERATOR_FLAG_SUPPORTED
#pragma GCC diagnostic pop
#endif
 
namespace isc {
namespace netconf {

class NetconfAgent;

using NetconfAgentPtr = std::shared_ptr<NetconfAgent>;

class NetconfAgent {
public:
    virtual ~NetconfAgent();

    void initSysrepo();

    void init(NetconfCfgMgrPtr cfg_mgr);

    void clear();

    static sysrepo::ErrorCode change(sysrepo::Session sess, const CfgServersMapPair& service_pair);

    static sysrepo::ErrorCode done(sysrepo::Session sess, const CfgServersMapPair& service_pair);

    static void logChanges(sysrepo::Session sess, std::string_view const& model);
 
protected:
    void keaConfig(const CfgServersMapPair& service_pair);

    bool checkModule(const std::string& module_name) const;

    void getModules();

    void checkModules(CfgServersMapPtr const& servers = {}) const;

    void yangConfig(const CfgServersMapPair& service_pair);

    void subscribeToDataChanges(const CfgServersMapPair& service_pair);

    void subscribeToNotifications(const CfgServersMapPair& service_pair);

    void announceShutdown() const;

    bool shouldShutdown() const;

    std::optional<sysrepo::Session> startup_sess_;

    std::optional<sysrepo::Session> running_sess_;

    std::map<const std::string, const std::string> modules_;

    std::map<const std::string, sysrepo::Subscription> subscriptions_;
};  // NetconfAgent
 
}  // namespace netconf
}  // namespace isc
 
#endif  // NETCONF_H