Kea  2.1.7-git
isc::agent::CtrlAgentController Class Reference

Process Controller for Control Agent Process. More...

#include <ca_controller.h>

+ Inheritance diagram for isc::agent::CtrlAgentController:

Public Member Functions

virtual ~CtrlAgentController ()
 Destructor. More...
 
void deregisterCommands ()
 Deregister commands. More...
 
CtrlAgentProcessPtr getCtrlAgentProcess ()
 Returns pointer to an instance of the underlying process object. More...
 
isc::data::ConstElementPtr parseFile (const std::string &name)
 Parses the configuration file using Agent::ParserContext (bison) More...
 
void registerCommands ()
 Register commands. More...
 
- Public Member Functions inherited from isc::process::DControllerBase
 DControllerBase (const char *app_name, const char *bin_name)
 Constructor. More...
 
virtual ~DControllerBase ()
 Destructor. More...
 
isc::data::ConstElementPtr buildReportHandler (const std::string &command, isc::data::ConstElementPtr args)
 handler for 'build-report' command More...
 
virtual isc::data::ConstElementPtr checkConfig (isc::data::ConstElementPtr new_config)
 Instance method invoked by the configuration event handler and which processes the actual configuration check. More...
 
virtual isc::data::ConstElementPtr configFromFile ()
 Reconfigures the process from a configuration file. More...
 
isc::data::ConstElementPtr configGetHandler (const std::string &command, isc::data::ConstElementPtr args)
 handler for config-get command More...
 
isc::data::ConstElementPtr configReloadHandler (const std::string &command, isc::data::ConstElementPtr args)
 handler for config-reload command More...
 
isc::data::ConstElementPtr configSetHandler (const std::string &command, isc::data::ConstElementPtr args)
 handler for config-set command More...
 
isc::data::ConstElementPtr configTestHandler (const std::string &command, isc::data::ConstElementPtr args)
 handler for config-test command More...
 
isc::data::ConstElementPtr configWriteHandler (const std::string &command, isc::data::ConstElementPtr args)
 handler for config-write command More...
 
std::string getAppName () const
 Fetches the name of the application under control. More...
 
std::string getBinName () const
 Fetches the name of the application executable. More...
 
std::string getVersion (bool extended)
 returns Kea version on stdout and exit. More...
 
virtual int launch (int argc, char *argv[], const bool test_mode)
 Acts as the primary entry point into the controller execution and provides the outermost application control logic: More...
 
isc::data::ConstElementPtr serverTagGetHandler (const std::string &command, isc::data::ConstElementPtr args)
 handler for server-tag-get command More...
 
isc::data::ConstElementPtr shutdownHandler (const std::string &command, isc::data::ConstElementPtr args)
 handler for 'shutdown' command More...
 
isc::data::ConstElementPtr statusGetHandler (const std::string &command, isc::data::ConstElementPtr args)
 handler for status-get command More...
 
virtual isc::data::ConstElementPtr updateConfig (isc::data::ConstElementPtr new_config)
 Instance method invoked by the configuration event handler and which processes the actual configuration update. More...
 
isc::data::ConstElementPtr versionGetHandler (const std::string &command, isc::data::ConstElementPtr args)
 handler for version-get command More...
 
- Public Member Functions inherited from isc::process::Daemon
 Daemon ()
 Default constructor. More...
 
virtual ~Daemon ()
 Destructor. More...
 
void checkConfigFile () const
 Checks the configuration file name. More...
 
virtual void cleanup ()
 Performs final deconfiguration. More...
 
void createPIDFile (int pid=0)
 Creates the PID file. More...
 
std::string getConfigFile () const
 Returns config file name. More...
 
int getExitValue ()
 Fetches the exit value. More...
 
std::string getPIDFileDir () const
 Returns the directory used when forming default PID file name. More...
 
std::string getPIDFileName () const
 Returns the current PID file name. More...
 
virtual std::list< std::list< std::string > > jsonPathsToRedact () const
 Return a list of all paths that contain passwords or secrets. More...
 
isc::data::ConstElementPtr redactConfig (isc::data::ConstElementPtr const &config)
 Redact a configuration. More...
 
void setConfigFile (const std::string &config_file)
 Sets the configuration file name. More...
 
void setExitValue (int value)
 Sets the exit value. More...
 
void setPIDFileDir (const std::string &pid_file_dir)
 Sets the PID file directory. More...
 
void setPIDFileName (const std::string &pid_file_name)
 Sets PID file name. More...
 
virtual void shutdown ()
 Initiates shutdown procedure for the whole server. More...
 
virtual size_t writeConfigFile (const std::string &config_file, isc::data::ConstElementPtr cfg=isc::data::ConstElementPtr()) const
 Writes current configuration to specified file. More...
 

Static Public Member Functions

static process::DControllerBasePtrinstance ()
 Static singleton instance method. More...
 
- Static Public Member Functions inherited from isc::process::Daemon
static void configureLogger (const isc::data::ConstElementPtr &log_config, const isc::process::ConfigPtr &storage)
 Configures logger. More...
 
static std::string getDefaultLoggerName ()
 Returns default logger name. More...
 
static std::string getProcName ()
 returns the process name This value is used as when forming the default PID file name More...
 
static bool getVerbose ()
 Returns if running in verbose mode. More...
 
static std::string getVersion (bool extended)
 returns Kea version on stdout and exits. More...
 
static void loggerInit (const char *log_name, bool verbose)
 Initializes logger. More...
 
static void setDefaultLoggerName (const std::string &logger)
 Sets the default logger name. More...
 
static void setProcName (const std::string &proc_name)
 Sets the process name. More...
 
static void setVerbose (const bool verbose)
 Sets or clears verbose mode. More...
 

Static Public Attributes

static const char * agent_app_name_ = "Control-agent"
 Defines the application name, this is passed into base class and appears in log statements. More...
 
static const char * agent_bin_name_ = "kea-ctrl-agent"
 Defines the executable name. More...
 

Additional Inherited Members

- Protected Member Functions inherited from isc::process::DControllerBase
void checkConfigOnly ()
 Check the configuration. More...
 
virtual bool customOption (int option, char *optarg)
 Virtual method that provides derivations the opportunity to support additional command line options. More...
 
virtual const std::string getCustomOpts () const
 Virtual method which returns a string containing the option letters for any custom command line options supported by the derivation. More...
 
asiolink::IOServicePtrgetIOService ()
 Getter for fetching the controller's IOService. More...
 
DProcessBasePtr getProcess ()
 Fetches the current process. More...
 
virtual const std::string getUsageText () const
 Virtual method which can be used to contribute derivation specific usage text. More...
 
virtual std::string getVersionAddendum ()
 Fetches text containing additional version specifics. More...
 
std::string handleOtherObjects (isc::data::ConstElementPtr args)
 Deals with other (i.e. More...
 
void initProcess ()
 Instantiates the application process and then initializes it. More...
 
void initSignalHandling ()
 Initializes signal handling. More...
 
bool isCheckOnly () const
 Supplies whether or not check only mode is enabled. More...
 
bool isVerbose () const
 Supplies whether or not verbose logging is enabled. More...
 
void parseArgs (int argc, char *argv[])
 Processes the command line arguments. More...
 
virtual isc::data::ConstElementPtr parseText (const std::string &input)
 Parse text into Elements. More...
 
virtual void processSignal (int signum)
 Application-level signal processing method. More...
 
void runProcess ()
 Invokes the application process's event loop,(DBaseProcess::run). More...
 
void setCheckOnly (bool value)
 Method for enabling or disabling check only mode. More...
 
void setVerbose (bool value)
 Method for enabling or disabling verbose logging. More...
 
isc::data::ConstElementPtr shutdownProcess (isc::data::ConstElementPtr args)
 Initiates shutdown procedure. More...
 
void usage (const std::string &text)
 Prints the program usage text to std error. More...
 
- Protected Member Functions inherited from isc::process::Daemon
std::string makePIDFileName () const
 Manufacture the pid file name. More...
 
- Static Protected Member Functions inherited from isc::process::DControllerBase
static DControllerBasePtrgetController ()
 Static getter which returns the singleton instance. More...
 
static void setController (const DControllerBasePtr &controller)
 Static setter which sets the singleton instance. More...
 
- Protected Attributes inherited from isc::process::Daemon
isc::asiolink::IOSignalSetPtr signal_set_
 A pointer to the object installing custom signal handlers. More...
 
boost::posix_time::ptime start_
 Timestamp of the start of the daemon. More...
 

Detailed Description

Process Controller for Control Agent Process.

This class is the Control Agent specific derivation of the DControllerBase. It creates and manages an instance of the Control Agent application process, CtrlAgentProcess.

Definition at line 21 of file ca_controller.h.

Constructor & Destructor Documentation

◆ ~CtrlAgentController()

isc::agent::CtrlAgentController::~CtrlAgentController ( )
virtual

Destructor.

Definition at line 101 of file ca_controller.cc.

Member Function Documentation

◆ deregisterCommands()

void isc::agent::CtrlAgentController::deregisterCommands ( )

Deregister commands.

Definition at line 85 of file ca_controller.cc.

Referenced by isc::agent::CtrlAgentProcess::run().

◆ getCtrlAgentProcess()

CtrlAgentProcessPtr isc::agent::CtrlAgentController::getCtrlAgentProcess ( )

Returns pointer to an instance of the underlying process object.

Definition at line 105 of file ca_controller.cc.

Referenced by isc::agent::CtrlAgentResponseCreator::createStockHttpResponse(), and isc::agent::CtrlAgentCommandMgr::handleCommand().

◆ instance()

DControllerBasePtr & isc::agent::CtrlAgentController::instance ( )
static

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.

Returns
returns the pointer reference to the singleton instance.

Definition at line 30 of file ca_controller.cc.

Referenced by main(), and isc::agent::CtrlAgentProcess::run().

◆ parseFile()

isc::data::ConstElementPtr isc::agent::CtrlAgentController::parseFile ( const std::string &  name)
virtual

Parses the configuration file using Agent::ParserContext (bison)

Parameters
namename of the text file to be parsed
Returns
Element tree structure representing parsed configuration

Reimplemented from isc::process::DControllerBase.

Definition at line 49 of file ca_controller.cc.

References isc::agent::ParserContext::parseFile().

+ Here is the call graph for this function:

◆ registerCommands()

Member Data Documentation

◆ agent_app_name_

const char * isc::agent::CtrlAgentController::agent_app_name_ = "Control-agent"
static

Defines the application name, this is passed into base class and appears in log statements.

Defines the application name, this is passed into base class it may be used to locate configuration data and appears in log statement.

Definition at line 41 of file ca_controller.h.

◆ agent_bin_name_

const char * isc::agent::CtrlAgentController::agent_bin_name_ = "kea-ctrl-agent"
static

Defines the executable name.

Defines the executable name. This is passed into the base class.

This is passed into the base class by convention this should match the executable name.

Definition at line 45 of file ca_controller.h.


The documentation for this class was generated from the following files: