isc::config::CommandMgr Class Reference

Commands Manager implementation for the Kea servers. More...

#include <command_mgr.h>

Inheritance diagram for isc::config::CommandMgr:

Static Public Member Functions
static CommandMgr &	instance ()
	CommandMgr is a singleton class.
Static Public Member Functions inherited from isc::config::BaseCommandMgr
static std::string	getHash (const isc::data::ConstElementPtr &config)
	returns a hash of a given Element structure

Additional Inherited Members
Public Types inherited from isc::config::BaseCommandMgr
typedef std::function< isc::data::ConstElementPtr(const std::string &name, const isc::data::ConstElementPtr &params)>	CommandHandler
	Defines command handler type.
typedef std::function< isc::data::ConstElementPtr(const std::string &name, const isc::data::ConstElementPtr &params, const isc::data::ConstElementPtr &original)>	ExtendedCommandHandler
	Defines extended command handler type.
Public Member Functions inherited from isc::config::HookedCommandMgr
	HookedCommandMgr ()
	Constructor.
Public Member Functions inherited from isc::config::BaseCommandMgr
	BaseCommandMgr ()
	Constructor.
virtual	~BaseCommandMgr ()
	Destructor.
void	deregisterAll ()
	Auxiliary method that removes all installed commands.
void	deregisterCommand (const std::string &cmd)
	Deregisters specified command handler.
virtual isc::data::ConstElementPtr	processCommand (const isc::data::ConstElementPtr &cmd)
	Triggers command processing.
void	registerCommand (const std::string &cmd, CommandHandler handler)
	Registers specified command handler for a given command.
void	registerExtendedCommand (const std::string &cmd, ExtendedCommandHandler handler)
	Registers specified command handler for a given command.
Protected Types inherited from isc::config::BaseCommandMgr
typedef std::map< std::string, HandlersPair >	HandlerContainer
	Type of the container for command handlers.
Protected Member Functions inherited from isc::config::HookedCommandMgr
bool	delegateCommandToHookLibrary (const std::string &cmd_name, const isc::data::ConstElementPtr &params, const isc::data::ConstElementPtr &original_cmd, isc::data::ElementPtr &answer)
	Handles the command within the hooks libraries.
virtual isc::data::ConstElementPtr	handleCommand (const std::string &cmd_name, const isc::data::ConstElementPtr &params, const isc::data::ConstElementPtr &original_cmd)
	Handles the command having a given name and arguments.
Protected Member Functions inherited from isc::config::BaseCommandMgr
Protected Attributes inherited from isc::config::BaseCommandMgr
HandlerContainer	handlers_
	Container for command handlers.

Detailed Description

Commands Manager implementation for the Kea servers.

This class extends BaseCommandMgr with the ability to receive and respond to commands over unix domain sockets.

Definition at line 20 of file command_mgr.h.

Member Function Documentation

instance()

CommandMgr & isc::config::CommandMgr::instance ( )

static

CommandMgr is a singleton class.

This method returns reference to its sole instance.

Returns

the only existing instance of the manager.

Definition at line 18 of file command_mgr.cc.

Referenced by isc::dhcp::ControlledDhcpv4Srv::ControlledDhcpv4Srv(), isc::dhcp::ControlledDhcpv6Srv::ControlledDhcpv6Srv(), isc::dhcp::ControlledDhcpv4Srv::~ControlledDhcpv4Srv(), isc::dhcp::ControlledDhcpv6Srv::~ControlledDhcpv6Srv(), isc::d2::D2Controller::deregisterCommands(), isc::dhcp::ControlledDhcpv4Srv::loadConfigFile(), isc::dhcp::ControlledDhcpv6Srv::loadConfigFile(), and isc::d2::D2Controller::registerCommands().

---

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

• command_mgr.h
• command_mgr.cc