blob: 0d5224de5750b038d35bab8cdec1740b3eea4020 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
// Copyright (C) 2018-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 NETCONF_CONTROLLER_H
#define NETCONF_CONTROLLER_H
#include <netconf/netconf_process.h>
#include <process/d_controller.h>
namespace isc {
namespace netconf {
/// @brief Process Controller for Netconf Process.
///
/// This class is the Netconf specific derivation of the DControllerBase.
/// It creates and manages an instance of the Netconf application process,
/// NetconfProcess.
class NetconfController : public process::DControllerBase {
public:
/// @brief Static singleton instance method.
///
/// This method returns the base class singleton instance member.
/// It instantiates the singleton and sets the base class instance
/// member upon first invocation.
///
/// @return returns the pointer reference to the singleton instance.
static process::DControllerBasePtr& instance();
/// @brief Destructor
virtual ~NetconfController() = default;
/// @brief Returns pointer to an instance of the underlying process object.
NetconfProcessPtr getNetconfProcess();
/// @brief Defines the application name, this is passed into base class
/// and appears in log statements.
static const char* netconf_app_name_;
/// @brief Defines the executable name. This is passed into the base class
/// by convention this should match the executable name.
static const char* netconf_bin_name_;
/// @brief Parses the configuration file using Netconf::ParserContext (bison)
///
/// @param name name of the text file to be parsed
/// @return Element tree structure representing parsed configuration
isc::data::ConstElementPtr
parseFile(const std::string& name) override final;
/// @brief Redefined application-level signal processing method.
///
/// This method ignores SIGHUP as configuration reloading is not yet
/// supported.
/// @param signum signal number to process.
void processSignal(int signum) override final;
private:
/// @brief Creates an instance of the Netconf application process.
///
/// This method is invoked during the process initialization step of
/// the controller launch.
///
/// @return returns a DProcessBase* to the application process created.
/// Note the caller is responsible for destructing the process. This
/// is handled by the base class, which wraps this pointer with a smart
/// pointer.
process::DProcessBase* createProcess() override final;
/// @brief Constructor is declared private to maintain the integrity of
/// the singleton instance.
NetconfController();
}; // NetconfController
// @Defines a shared pointer to NetconfController
using NetconfControllerPtr = std::shared_ptr<NetconfController>;
} // namespace netconf
} // namespace isc
#endif // NETCONF_CONTROLLER_H
|
