Kea  2.1.7-git
isc::config Namespace Reference

Classes

class  BadSocketInfo
 An exception indicating that specified socket parameters are invalid. More...
 
class  BaseCommandMgr
 Commands Manager, responsible for processing external commands. More...
 
class  ClientConnection
 Represents client side connection over the unix domain socket. More...
 
class  ClientConnectionImpl
 Implementation of the ClientConnection. More...
 
class  CmdHttpListener
 A multi-threaded HTTP listener that can process API commands requests. More...
 
class  CmdResponseCreator
 Concrete implementation of the HTTP response creator used for processing API commands. More...
 
class  CmdResponseCreatorFactory
 HTTP response creator factory for an API listener. More...
 
class  CmdsImpl
 Base class that command handler implementers may use for common tasks. More...
 
class  CommandMgr
 Commands Manager implementation for the Kea servers. More...
 
class  CommandMgrImpl
 Implementation of the CommandMgr. More...
 
class  CtrlChannelError
 A standard control channel exception that is thrown if a function is there is a problem with one of the messages. More...
 
class  HookedCommandMgr
 Command Manager which can delegate commands to a hook library. More...
 
class  InvalidCommandHandler
 Exception indicating that the handler specified is not valid. More...
 
class  InvalidCommandName
 Exception indicating that the command name is not valid. More...
 
class  JSONFeed
 State model for asynchronous read of data in JSON format. More...
 
class  JSONFeedError
 A generic exception thrown upon an error in the JSONFeed. More...
 
class  SocketError
 An exception indicating a problem with socket operation. More...
 

Typedefs

typedef boost::shared_ptr< ClientConnectionClientConnectionPtr
 Type of the pointer to the ClientConnection object. More...
 
typedef boost::shared_ptr< CmdHttpListenerCmdHttpListenerPtr
 Defines a shared pointer to CmdHttpListener. More...
 
typedef boost::shared_ptr< CmdResponseCreatorCmdResponseCreatorPtr
 Pointer to the CmdResponseCreator. More...
 
typedef boost::shared_ptr< const JSONFeedConstJSONFeedPtr
 Pointer to the const JSONFeed. More...
 
typedef boost::shared_ptr< JSONFeedJSONFeedPtr
 Pointer to the JSONFeed. More...
 

Functions

std::string answerToText (const ConstElementPtr &msg)
 
std::string answerToText (const isc::data::ConstElementPtr &msg)
 Converts answer to printable text. More...
 
isc::data::ConstElementPtr combineCommandsLists (const isc::data::ConstElementPtr &response1, const isc::data::ConstElementPtr &response2)
 Combines lists of commands carried in two responses. More...
 
ConstElementPtr combineCommandsLists (const ConstElementPtr &response1, const ConstElementPtr &response2)
 
ConstElementPtr createAnswer (const int status_code, const std::string &text, const ConstElementPtr &arg)
 
ConstElementPtr createAnswer ()
 Creates a standard config/command level success answer message (i.e. More...
 
ConstElementPtr createAnswer (const int status_code, const std::string &status_text)
 Creates a standard config/command level answer message (i.e. More...
 
ConstElementPtr createAnswer (const int status_code, const ConstElementPtr &arg)
 
isc::data::ConstElementPtr createAnswer (const int status_code, const isc::data::ConstElementPtr &arg)
 Creates a standard config/command level answer message (i.e. More...
 
isc::data::ConstElementPtr createAnswer (const int status_code, const std::string &status, const isc::data::ConstElementPtr &arg)
 Creates a standard config/command level answer message. More...
 
isc::data::ConstElementPtr createCommand (const std::string &command, isc::data::ConstElementPtr arg)
 Creates a standard command message with the given argument (of the form { "command": "my_command", "arguments": arg }. More...
 
ConstElementPtr createCommand (const std::string &command)
 Creates a standard command message with no argument (of the form { "command": "my_command" }) More...
 
ConstElementPtr createCommand (const std::string &command, ConstElementPtr arg)
 
ConstElementPtr createCommand (const std::string &command, const std::string &service)
 Creates a standard config/command command message with no argument and with the given service (of the form { "command": "my_command", "service": [ service ] }) More...
 
isc::data::ConstElementPtr createCommand (const std::string &command, isc::data::ConstElementPtr arg, const std::string &service)
 Creates a standard config/command command message with the given argument and given service (of the form { "command": "my_command", "arguments": arg, "service": [ service ] }. More...
 
ConstElementPtr createCommand (const std::string &command, ConstElementPtr arg, const std::string &service)
 
ConstElementPtr parseAnswer (int &rcode, const ConstElementPtr &msg)
 
isc::data::ConstElementPtr parseAnswer (int &status_code, const isc::data::ConstElementPtr &msg)
 Parses a standard config/command level answer message. More...
 
std::string parseCommand (isc::data::ConstElementPtr &arg, isc::data::ConstElementPtr command)
 Parses the given command into a string containing the actual command and an ElementPtr containing the optional argument. More...
 
std::string parseCommand (ConstElementPtr &arg, ConstElementPtr command)
 
std::string parseCommandWithArgs (isc::data::ConstElementPtr &arg, isc::data::ConstElementPtr command)
 Parses the given command into a string containing the command name and an ElementPtr containing the mandatory argument. More...
 
std::string parseCommandWithArgs (ConstElementPtr &arg, ConstElementPtr command)
 

Variables

const isc::log::MessageID COMMAND_ACCEPTOR_START = "COMMAND_ACCEPTOR_START"
 
const isc::log::MessageID COMMAND_DEREGISTERED = "COMMAND_DEREGISTERED"
 
const isc::log::MessageID COMMAND_EXTENDED_REGISTERED = "COMMAND_EXTENDED_REGISTERED"
 
const isc::log::MessageID COMMAND_HTTP_LISTENER_COMMAND_REJECTED = "COMMAND_HTTP_LISTENER_COMMAND_REJECTED"
 
const isc::log::MessageID COMMAND_HTTP_LISTENER_STARTED = "COMMAND_HTTP_LISTENER_STARTED"
 
const isc::log::MessageID COMMAND_HTTP_LISTENER_STOPPED = "COMMAND_HTTP_LISTENER_STOPPED"
 
const isc::log::MessageID COMMAND_HTTP_LISTENER_STOPPING = "COMMAND_HTTP_LISTENER_STOPPING"
 
isc::log::Logger command_logger ("commands")
 Command processing Logger. More...
 
const isc::log::MessageID COMMAND_PROCESS_ERROR1 = "COMMAND_PROCESS_ERROR1"
 
const isc::log::MessageID COMMAND_PROCESS_ERROR2 = "COMMAND_PROCESS_ERROR2"
 
const isc::log::MessageID COMMAND_RECEIVED = "COMMAND_RECEIVED"
 
const isc::log::MessageID COMMAND_REGISTERED = "COMMAND_REGISTERED"
 
const isc::log::MessageID COMMAND_RESPONSE_ERROR = "COMMAND_RESPONSE_ERROR"
 
const isc::log::MessageID COMMAND_SOCKET_ACCEPT_FAIL = "COMMAND_SOCKET_ACCEPT_FAIL"
 
const isc::log::MessageID COMMAND_SOCKET_CLOSED_BY_FOREIGN_HOST = "COMMAND_SOCKET_CLOSED_BY_FOREIGN_HOST"
 
const isc::log::MessageID COMMAND_SOCKET_CONNECTION_CANCEL_FAIL = "COMMAND_SOCKET_CONNECTION_CANCEL_FAIL"
 
const isc::log::MessageID COMMAND_SOCKET_CONNECTION_CLOSE_FAIL = "COMMAND_SOCKET_CONNECTION_CLOSE_FAIL"
 
const isc::log::MessageID COMMAND_SOCKET_CONNECTION_CLOSED = "COMMAND_SOCKET_CONNECTION_CLOSED"
 
const isc::log::MessageID COMMAND_SOCKET_CONNECTION_OPENED = "COMMAND_SOCKET_CONNECTION_OPENED"
 
const isc::log::MessageID COMMAND_SOCKET_CONNECTION_SHUTDOWN_FAIL = "COMMAND_SOCKET_CONNECTION_SHUTDOWN_FAIL"
 
const isc::log::MessageID COMMAND_SOCKET_CONNECTION_TIMEOUT = "COMMAND_SOCKET_CONNECTION_TIMEOUT"
 
const isc::log::MessageID COMMAND_SOCKET_READ = "COMMAND_SOCKET_READ"
 
const isc::log::MessageID COMMAND_SOCKET_READ_FAIL = "COMMAND_SOCKET_READ_FAIL"
 
const isc::log::MessageID COMMAND_SOCKET_WRITE = "COMMAND_SOCKET_WRITE"
 
const isc::log::MessageID COMMAND_SOCKET_WRITE_FAIL = "COMMAND_SOCKET_WRITE_FAIL"
 
const isc::log::MessageID COMMAND_WATCH_SOCKET_CLEAR_ERROR = "COMMAND_WATCH_SOCKET_CLEAR_ERROR"
 
const isc::log::MessageID COMMAND_WATCH_SOCKET_CLOSE_ERROR = "COMMAND_WATCH_SOCKET_CLOSE_ERROR"
 
const isc::log::MessageID COMMAND_WATCH_SOCKET_MARK_READY_ERROR = "COMMAND_WATCH_SOCKET_MARK_READY_ERROR"
 
const char * CONTROL_ARGUMENTS = "arguments"
 String used for arguments map ("arguments") More...
 
const char * CONTROL_COMMAND = "command"
 String used for commands ("command") More...
 
const char * CONTROL_REMOTE_ADDRESS = "remote-address"
 String used for remote address ("remote-address") More...
 
const char * CONTROL_RESULT = "result"
 String used for result, i.e. integer status ("result") More...
 
const int CONTROL_RESULT_COMMAND_UNSUPPORTED = 2
 Status code indicating that the specified command is not supported. More...
 
const int CONTROL_RESULT_EMPTY = 3
 Status code indicating that the specified command was completed correctly, but failed to produce any results. More...
 
const int CONTROL_RESULT_ERROR = 1
 Status code indicating a general failure. More...
 
const int CONTROL_RESULT_SUCCESS = 0
 Status code indicating a successful operation. More...
 
const char * CONTROL_SERVICE = "service"
 String used for service list ("service") More...
 
const char * CONTROL_TEXT = "text"
 String used for storing textual description ("text") More...
 
const int DBG_COMMAND = isc::log::DBGLVL_COMMAND
 
constexpr long TIMEOUT_AGENT_FORWARD_COMMAND = 60000
 Timeout for the Control Agent to forward command to a Kea server, e.g. More...
 
constexpr long TIMEOUT_AGENT_IDLE_CONNECTION_TIMEOUT = 30000
 Timeout for the idle connection to be closed. More...
 
constexpr long TIMEOUT_AGENT_RECEIVE_COMMAND = 10000
 Timeout for the Control Agent to receive command over the RESTful interface. More...
 
constexpr long TIMEOUT_DEFAULT_HTTP_CLIENT_REQUEST = 10000
 Timeout for the HTTP clients awaiting a response to a request. More...
 
constexpr long TIMEOUT_DHCP_SERVER_RECEIVE_COMMAND = 10000
 Timeout for the DHCP server to receive command over the unix domain socket. More...
 

Typedef Documentation

◆ ClientConnectionPtr

Type of the pointer to the ClientConnection object.

Definition at line 154 of file client_connection.h.

◆ CmdHttpListenerPtr

Defines a shared pointer to CmdHttpListener.

Definition at line 155 of file cmd_http_listener.h.

◆ CmdResponseCreatorPtr

Pointer to the CmdResponseCreator.

Definition at line 127 of file cmd_response_creator.h.

◆ ConstJSONFeedPtr

typedef boost::shared_ptr<const JSONFeed> isc::config::ConstJSONFeedPtr

Pointer to the const JSONFeed.

Definition at line 27 of file json_feed.h.

◆ JSONFeedPtr

typedef boost::shared_ptr<JSONFeed> isc::config::JSONFeedPtr

Pointer to the JSONFeed.

Definition at line 21 of file json_feed.h.

Function Documentation

◆ answerToText() [1/2]

◆ answerToText() [2/2]

std::string isc::config::answerToText ( const isc::data::ConstElementPtr msg)

Converts answer to printable text.

Parameters
msganswer to be parsed
Returns
printable string

◆ combineCommandsLists() [1/2]

isc::data::ConstElementPtr isc::config::combineCommandsLists ( const isc::data::ConstElementPtr response1,
const isc::data::ConstElementPtr response2 
)

Combines lists of commands carried in two responses.

This method is used to combine list of commands returned by the two command managers.

If the same command appears in two responses only a single instance is returned in the combined response.

Parameters
response1First command response.
response2Second command response.
Returns
Pointer to the 'list-commands' response holding combined list of commands.

◆ combineCommandsLists() [2/2]

ConstElementPtr isc::config::combineCommandsLists ( const ConstElementPtr &  response1,
const ConstElementPtr &  response2 
)

Definition at line 233 of file command_interpreter.cc.

References CONTROL_RESULT_SUCCESS, createAnswer(), and parseAnswer().

Referenced by isc::config::CtrlChannelError::CtrlChannelError(), and isc::config::HookedCommandMgr::handleCommand().

+ Here is the call graph for this function:

◆ createAnswer() [1/6]

ConstElementPtr isc::config::createAnswer ( const int  status_code,
const std::string &  text,
const ConstElementPtr &  arg 
)

Definition at line 34 of file command_interpreter.cc.

References isc_throw.

Referenced by isc::process::DControllerBase::buildReportHandler(), isc::dhcp::ControlledDhcpv6Srv::checkConfig(), isc::dhcp::ControlledDhcpv4Srv::checkConfig(), isc::dhcp::ControlledDhcpv6Srv::cleanup(), isc::process::DControllerBase::configFromFile(), isc::process::DControllerBase::configGetHandler(), isc::netconf::StdoutControlSocket::configSet(), isc::process::DControllerBase::configSetHandler(), isc::netconf::StdoutControlSocket::configTest(), isc::process::DControllerBase::configTestHandler(), isc::d2::D2Process::configure(), isc::dhcp::configureDhcp4Server(), isc::dhcp::configureDhcp6Server(), isc::process::DControllerBase::configWriteHandler(), isc::config::CtrlChannelError::CtrlChannelError(), isc::config::HookedCommandMgr::handleCommand(), isc::agent::CtrlAgentCommandMgr::handleCommand(), isc::config::BaseCommandMgr::handleCommand(), isc::lease_cmds::LeaseCmdsImpl::lease4WipeHandler(), isc::lease_cmds::LeaseCmdsImpl::lease6BulkApplyHandler(), isc::lease_cmds::LeaseCmdsImpl::lease6WipeHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetAllHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetByClientIdHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetByDuidHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetByHostnameHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetByHwAddressHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetPageHandler(), isc::dhcp::ControlledDhcpv4Srv::loadConfigFile(), isc::netconf::NetconfCfgMgr::parse(), isc::agent::CtrlAgentCfgMgr::parse(), isc::d2::D2CfgMgr::parse(), isc::dhcp::ControlledDhcpv4Srv::processCommand(), isc::dhcp::ControlledDhcpv6Srv::processCommand(), isc::config::BaseCommandMgr::processCommand(), isc::dhcp::ControlledDhcpv4Srv::processConfig(), isc::dhcp::ControlledDhcpv6Srv::processConfig(), isc::ha::HAService::processContinue(), isc::ha::HAService::processHAReset(), isc::ha::HAService::processHeartbeat(), isc::ha::HAService::processMaintenanceCancel(), isc::ha::HAService::processMaintenanceNotify(), isc::ha::HAService::processMaintenanceStart(), isc::ha::HAService::processScopes(), isc::ha::HAService::processSyncCompleteNotify(), isc::ha::HAService::processSynchronize(), isc::ha::HAImpl::scopesHandler(), isc::process::DControllerBase::serverTagGetHandler(), isc::config::CmdsImpl::setErrorResponse(), isc::config::CmdsImpl::setSuccessResponse(), isc::netconf::NetconfProcess::shutdown(), isc::agent::CtrlAgentProcess::shutdown(), isc::d2::D2Process::shutdown(), isc::process::DControllerBase::shutdownHandler(), isc::process::DControllerBase::shutdownProcess(), isc::process::DCfgMgrBase::simpleParseConfig(), isc::stats::StatsMgr::statisticGetAllHandler(), isc::stats::StatsMgr::statisticGetHandler(), isc::stats::StatsMgr::statisticRemoveAllHandler(), isc::stats::StatsMgr::statisticRemoveHandler(), isc::stats::StatsMgr::statisticResetAllHandler(), isc::stats::StatsMgr::statisticResetHandler(), isc::stats::StatsMgr::statisticSetMaxSampleAgeAllHandler(), isc::stats::StatsMgr::statisticSetMaxSampleAgeHandler(), isc::stats::StatsMgr::statisticSetMaxSampleCountAllHandler(), isc::stats::StatsMgr::statisticSetMaxSampleCountHandler(), isc::stat_cmds::LeaseStatCmdsImpl::statLease4GetHandler(), isc::stat_cmds::LeaseStatCmdsImpl::statLease6GetHandler(), isc::process::DControllerBase::statusGetHandler(), isc::ha::HAImpl::synchronizeHandler(), and isc::process::DControllerBase::versionGetHandler().

◆ createAnswer() [2/6]

isc::data::ConstElementPtr isc::config::createAnswer ( )

Creates a standard config/command level success answer message (i.e.

of the form { "result": 0 }

Returns
Standard command/config success answer message

Definition at line 54 of file command_interpreter.cc.

References createAnswer().

+ Here is the call graph for this function:

◆ createAnswer() [3/6]

isc::data::ConstElementPtr isc::config::createAnswer ( const int  status_code,
const std::string &  status_text 
)

Creates a standard config/command level answer message (i.e.

of the form { "result": 1, "text": "Invalid command received" }

Parameters
status_codeThe return code (0 for success)
status_textA string to put into the "text" argument
Returns
Standard command/config answer message

Definition at line 59 of file command_interpreter.cc.

References createAnswer().

+ Here is the call graph for this function:

◆ createAnswer() [4/6]

ConstElementPtr isc::config::createAnswer ( const int  status_code,
const ConstElementPtr &  arg 
)

Definition at line 64 of file command_interpreter.cc.

Referenced by combineCommandsLists(), and createAnswer().

◆ createAnswer() [5/6]

isc::data::ConstElementPtr isc::config::createAnswer ( const int  status_code,
const isc::data::ConstElementPtr arg 
)

Creates a standard config/command level answer message (i.e.

of the form { "result": status_code, "arguments": arg }

Parameters
status_codeThe return code (0 for success)
argThe optional argument for the answer. This can be of any Element type. May be NULL.
Returns
Standard command/config answer message

◆ createAnswer() [6/6]

isc::data::ConstElementPtr isc::config::createAnswer ( const int  status_code,
const std::string &  status,
const isc::data::ConstElementPtr arg 
)

Creates a standard config/command level answer message.

Parameters
status_codeThe return code (0 for success)
statustextual representation of the status (used mostly for errors)
argThe optional argument for the answer. This can be of any Element type. May be NULL.
Returns
Standard command/config answer message

◆ createCommand() [1/6]

isc::data::ConstElementPtr isc::config::createCommand ( const std::string &  command,
isc::data::ConstElementPtr  arg 
)

Creates a standard command message with the given argument (of the form { "command": "my_command", "arguments": arg }.

Parameters
commandThe command string
argThe optional argument for the command. This can be of any Element type. May be NULL.
Returns
The created message

◆ createCommand() [2/6]

◆ createCommand() [3/6]

ConstElementPtr isc::config::createCommand ( const std::string &  command,
ConstElementPtr  arg 
)

Definition at line 143 of file command_interpreter.cc.

References createCommand().

+ Here is the call graph for this function:

◆ createCommand() [4/6]

isc::data::ConstElementPtr isc::config::createCommand ( const std::string &  command,
const std::string &  service 
)

Creates a standard config/command command message with no argument and with the given service (of the form { "command": "my_command", "service": [ service ] })

Parameters
commandThe command string
serviceThe target service. May be empty.
Returns
The created message

Definition at line 148 of file command_interpreter.cc.

References createCommand().

+ Here is the call graph for this function:

◆ createCommand() [5/6]

isc::data::ConstElementPtr isc::config::createCommand ( const std::string &  command,
isc::data::ConstElementPtr  arg,
const std::string &  service 
)

Creates a standard config/command command message with the given argument and given service (of the form { "command": "my_command", "arguments": arg, "service": [ service ] }.

Parameters
commandThe command string
argThe optional argument for the command. This can be of any Element type. May be NULL.
serviceThe target service. May be empty.
Returns
The created message

◆ createCommand() [6/6]

ConstElementPtr isc::config::createCommand ( const std::string &  command,
ConstElementPtr  arg,
const std::string &  service 
)

Definition at line 153 of file command_interpreter.cc.

Referenced by createCommand().

◆ parseAnswer() [1/2]

◆ parseAnswer() [2/2]

isc::data::ConstElementPtr isc::config::parseAnswer ( int &  status_code,
const isc::data::ConstElementPtr msg 
)

Parses a standard config/command level answer message.

Parameters
status_codeThis value will be set to the return code contained in the message
msgThe message to parse
Returns
The optional argument in the message.

◆ parseCommand() [1/2]

std::string isc::config::parseCommand ( isc::data::ConstElementPtr arg,
isc::data::ConstElementPtr  command 
)

Parses the given command into a string containing the actual command and an ElementPtr containing the optional argument.

Exceptions
CtrlChannelErrorif this is not a well-formed command
Parameters
argThis value will be set to the ElementPtr pointing to the argument, or to an empty Map (ElementPtr) if there was none.
commandThe command message containing the command (as made by createCommand()
Returns
The command name.

◆ parseCommand() [2/2]

◆ parseCommandWithArgs() [1/2]

std::string isc::config::parseCommandWithArgs ( isc::data::ConstElementPtr arg,
isc::data::ConstElementPtr  command 
)

Parses the given command into a string containing the command name and an ElementPtr containing the mandatory argument.

This function expects that command arguments are specified and are a map.

Exceptions
CtrlChannelErrorif this is not a well-formed command, arguments are not specified or are not a map.
Parameters
argReference to the data element to which command arguments will be assigned.
commandThe command message containing the command and the arguments.
Returns
Command name.

◆ parseCommandWithArgs() [2/2]

std::string isc::config::parseCommandWithArgs ( ConstElementPtr &  arg,
ConstElementPtr  command 
)

Definition at line 207 of file command_interpreter.cc.

References isc_throw, and parseCommand().

Referenced by isc::config::CtrlChannelError::CtrlChannelError(), and isc::ha::HAImpl::maintenanceNotifyHandler().

+ Here is the call graph for this function:

Variable Documentation

◆ COMMAND_ACCEPTOR_START

const isc::log::MessageID isc::config::COMMAND_ACCEPTOR_START = "COMMAND_ACCEPTOR_START"

Definition at line 11 of file config_messages.h.

Referenced by isc::config::CommandMgrImpl::openCommandSocket().

◆ COMMAND_DEREGISTERED

const isc::log::MessageID isc::config::COMMAND_DEREGISTERED = "COMMAND_DEREGISTERED"

Definition at line 12 of file config_messages.h.

Referenced by isc::config::BaseCommandMgr::deregisterCommand().

◆ COMMAND_EXTENDED_REGISTERED

const isc::log::MessageID isc::config::COMMAND_EXTENDED_REGISTERED = "COMMAND_EXTENDED_REGISTERED"

◆ COMMAND_HTTP_LISTENER_COMMAND_REJECTED

const isc::log::MessageID isc::config::COMMAND_HTTP_LISTENER_COMMAND_REJECTED = "COMMAND_HTTP_LISTENER_COMMAND_REJECTED"

Definition at line 14 of file config_messages.h.

Referenced by isc::config::CmdResponseCreator::filterCommand().

◆ COMMAND_HTTP_LISTENER_STARTED

const isc::log::MessageID isc::config::COMMAND_HTTP_LISTENER_STARTED = "COMMAND_HTTP_LISTENER_STARTED"

Definition at line 15 of file config_messages.h.

Referenced by isc::config::CmdHttpListener::start().

◆ COMMAND_HTTP_LISTENER_STOPPED

const isc::log::MessageID isc::config::COMMAND_HTTP_LISTENER_STOPPED = "COMMAND_HTTP_LISTENER_STOPPED"

Definition at line 16 of file config_messages.h.

Referenced by isc::config::CmdHttpListener::stop().

◆ COMMAND_HTTP_LISTENER_STOPPING

const isc::log::MessageID isc::config::COMMAND_HTTP_LISTENER_STOPPING = "COMMAND_HTTP_LISTENER_STOPPING"

Definition at line 17 of file config_messages.h.

Referenced by isc::config::CmdHttpListener::stop().

◆ command_logger

isc::log::Logger isc::config::command_logger

◆ COMMAND_PROCESS_ERROR1

const isc::log::MessageID isc::config::COMMAND_PROCESS_ERROR1 = "COMMAND_PROCESS_ERROR1"

Definition at line 18 of file config_messages.h.

◆ COMMAND_PROCESS_ERROR2

const isc::log::MessageID isc::config::COMMAND_PROCESS_ERROR2 = "COMMAND_PROCESS_ERROR2"

Definition at line 19 of file config_messages.h.

Referenced by isc::config::BaseCommandMgr::processCommand().

◆ COMMAND_RECEIVED

const isc::log::MessageID isc::config::COMMAND_RECEIVED = "COMMAND_RECEIVED"

Definition at line 20 of file config_messages.h.

Referenced by isc::config::BaseCommandMgr::processCommand().

◆ COMMAND_REGISTERED

const isc::log::MessageID isc::config::COMMAND_REGISTERED = "COMMAND_REGISTERED"

Definition at line 21 of file config_messages.h.

Referenced by isc::config::BaseCommandMgr::registerCommand().

◆ COMMAND_RESPONSE_ERROR

const isc::log::MessageID isc::config::COMMAND_RESPONSE_ERROR = "COMMAND_RESPONSE_ERROR"

Definition at line 22 of file config_messages.h.

◆ COMMAND_SOCKET_ACCEPT_FAIL

const isc::log::MessageID isc::config::COMMAND_SOCKET_ACCEPT_FAIL = "COMMAND_SOCKET_ACCEPT_FAIL"

Definition at line 23 of file config_messages.h.

Referenced by isc::config::CommandMgrImpl::doAccept().

◆ COMMAND_SOCKET_CLOSED_BY_FOREIGN_HOST

const isc::log::MessageID isc::config::COMMAND_SOCKET_CLOSED_BY_FOREIGN_HOST = "COMMAND_SOCKET_CLOSED_BY_FOREIGN_HOST"

Definition at line 24 of file config_messages.h.

◆ COMMAND_SOCKET_CONNECTION_CANCEL_FAIL

const isc::log::MessageID isc::config::COMMAND_SOCKET_CONNECTION_CANCEL_FAIL = "COMMAND_SOCKET_CONNECTION_CANCEL_FAIL"

Definition at line 25 of file config_messages.h.

◆ COMMAND_SOCKET_CONNECTION_CLOSE_FAIL

const isc::log::MessageID isc::config::COMMAND_SOCKET_CONNECTION_CLOSE_FAIL = "COMMAND_SOCKET_CONNECTION_CLOSE_FAIL"

Definition at line 27 of file config_messages.h.

◆ COMMAND_SOCKET_CONNECTION_CLOSED

const isc::log::MessageID isc::config::COMMAND_SOCKET_CONNECTION_CLOSED = "COMMAND_SOCKET_CONNECTION_CLOSED"

Definition at line 26 of file config_messages.h.

◆ COMMAND_SOCKET_CONNECTION_OPENED

const isc::log::MessageID isc::config::COMMAND_SOCKET_CONNECTION_OPENED = "COMMAND_SOCKET_CONNECTION_OPENED"

Definition at line 28 of file config_messages.h.

◆ COMMAND_SOCKET_CONNECTION_SHUTDOWN_FAIL

const isc::log::MessageID isc::config::COMMAND_SOCKET_CONNECTION_SHUTDOWN_FAIL = "COMMAND_SOCKET_CONNECTION_SHUTDOWN_FAIL"

Definition at line 29 of file config_messages.h.

◆ COMMAND_SOCKET_CONNECTION_TIMEOUT

const isc::log::MessageID isc::config::COMMAND_SOCKET_CONNECTION_TIMEOUT = "COMMAND_SOCKET_CONNECTION_TIMEOUT"

Definition at line 30 of file config_messages.h.

◆ COMMAND_SOCKET_READ

const isc::log::MessageID isc::config::COMMAND_SOCKET_READ = "COMMAND_SOCKET_READ"

Definition at line 31 of file config_messages.h.

◆ COMMAND_SOCKET_READ_FAIL

const isc::log::MessageID isc::config::COMMAND_SOCKET_READ_FAIL = "COMMAND_SOCKET_READ_FAIL"

Definition at line 32 of file config_messages.h.

◆ COMMAND_SOCKET_WRITE

const isc::log::MessageID isc::config::COMMAND_SOCKET_WRITE = "COMMAND_SOCKET_WRITE"

Definition at line 33 of file config_messages.h.

◆ COMMAND_SOCKET_WRITE_FAIL

const isc::log::MessageID isc::config::COMMAND_SOCKET_WRITE_FAIL = "COMMAND_SOCKET_WRITE_FAIL"

Definition at line 34 of file config_messages.h.

◆ COMMAND_WATCH_SOCKET_CLEAR_ERROR

const isc::log::MessageID isc::config::COMMAND_WATCH_SOCKET_CLEAR_ERROR = "COMMAND_WATCH_SOCKET_CLEAR_ERROR"

Definition at line 35 of file config_messages.h.

◆ COMMAND_WATCH_SOCKET_CLOSE_ERROR

const isc::log::MessageID isc::config::COMMAND_WATCH_SOCKET_CLOSE_ERROR = "COMMAND_WATCH_SOCKET_CLOSE_ERROR"

Definition at line 36 of file config_messages.h.

◆ COMMAND_WATCH_SOCKET_MARK_READY_ERROR

const isc::log::MessageID isc::config::COMMAND_WATCH_SOCKET_MARK_READY_ERROR = "COMMAND_WATCH_SOCKET_MARK_READY_ERROR"

Definition at line 37 of file config_messages.h.

◆ CONTROL_ARGUMENTS

const char * isc::config::CONTROL_ARGUMENTS = "arguments"

String used for arguments map ("arguments")

Definition at line 28 of file command_interpreter.cc.

◆ CONTROL_COMMAND

const char * isc::config::CONTROL_COMMAND = "command"

String used for commands ("command")

Definition at line 25 of file command_interpreter.cc.

Referenced by isc::config::CmdResponseCreator::filterCommand().

◆ CONTROL_REMOTE_ADDRESS

const char * isc::config::CONTROL_REMOTE_ADDRESS = "remote-address"

String used for remote address ("remote-address")

Definition at line 30 of file command_interpreter.cc.

◆ CONTROL_RESULT

const char * isc::config::CONTROL_RESULT = "result"

String used for result, i.e. integer status ("result")

Definition at line 26 of file command_interpreter.cc.

Referenced by isc::config::CmdResponseCreator::filterCommand(), and isc::ha::HAService::verifyAsyncResponse().

◆ CONTROL_RESULT_COMMAND_UNSUPPORTED

const int isc::config::CONTROL_RESULT_COMMAND_UNSUPPORTED = 2

◆ CONTROL_RESULT_EMPTY

◆ CONTROL_RESULT_ERROR

const int isc::config::CONTROL_RESULT_ERROR = 1

Status code indicating a general failure.

Definition at line 45 of file command_interpreter.h.

Referenced by isc::dhcp::ControlledDhcpv6Srv::cleanup(), isc::dhcp::configureDhcp4Server(), isc::dhcp::configureDhcp6Server(), isc::agent::CtrlAgentCommandMgr::handleCommand(), isc::lease_cmds::LeaseCmdsImpl::lease4ResendDdnsHandler(), isc::lease_cmds::LeaseCmdsImpl::lease6BulkApplyHandler(), isc::lease_cmds::LeaseCmdsImpl::lease6ResendDdnsHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetAllHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetByClientIdHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetByDuidHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetByHostnameHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetByHwAddressHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetPageHandler(), load(), isc::dhcp::ControlledDhcpv4Srv::loadConfigFile(), isc::netconf::NetconfCfgMgr::parse(), isc::agent::CtrlAgentCfgMgr::parse(), isc::d2::D2CfgMgr::parse(), isc::config::BaseCommandMgr::processCommand(), isc::dhcp::ControlledDhcpv4Srv::processConfig(), isc::dhcp::ControlledDhcpv6Srv::processConfig(), isc::ha::HAService::processMaintenanceCancel(), isc::ha::HAService::processMaintenanceNotify(), isc::ha::HAService::processMaintenanceStart(), isc::ha::HAService::processScopes(), isc::ha::HAImpl::scopesHandler(), isc::process::DControllerBase::shutdownHandler(), isc::stats::StatsMgr::statisticGetHandler(), isc::stats::StatsMgr::statisticRemoveHandler(), isc::stats::StatsMgr::statisticResetHandler(), isc::stats::StatsMgr::statisticSetMaxSampleAgeAllHandler(), isc::stats::StatsMgr::statisticSetMaxSampleAgeHandler(), isc::stats::StatsMgr::statisticSetMaxSampleCountAllHandler(), isc::stats::StatsMgr::statisticSetMaxSampleCountHandler(), isc::ha::HAService::synchronize(), isc::ha::HAImpl::synchronizeHandler(), and isc::ha::HAService::verifyAsyncResponse().

◆ CONTROL_RESULT_SUCCESS

const int isc::config::CONTROL_RESULT_SUCCESS = 0

Status code indicating a successful operation.

Definition at line 42 of file command_interpreter.h.

Referenced by isc::ha::HAService::asyncSendLeaseUpdatesFromBacklog(), isc::netconf::NetconfAgent::change(), isc::dhcp::ControlledDhcpv6Srv::cleanup(), combineCommandsLists(), isc::process::DControllerBase::configWriteHandler(), isc::netconf::NetconfAgent::done(), isc::config::BaseCommandMgr::handleCommand(), isc::dhcp::ControlledDhcpv6Srv::init(), isc::dhcp::ControlledDhcpv4Srv::init(), isc::netconf::NetconfAgent::keaConfig(), isc::lease_cmds::LeaseCmdsImpl::lease4WipeHandler(), isc::lease_cmds::LeaseCmdsImpl::lease6BulkApplyHandler(), isc::lease_cmds::LeaseCmdsImpl::lease6WipeHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetAllHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetByClientIdHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetByDuidHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetByHostnameHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetByHwAddressHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetHandler(), isc::lease_cmds::LeaseCmdsImpl::leaseGetPageHandler(), isc::dhcp::ControlledDhcpv4Srv::loadConfigFile(), isc::dhcp::ControlledDhcpv6Srv::loadConfigFile(), isc::netconf::NetconfCfgMgr::parse(), isc::agent::CtrlAgentCfgMgr::parse(), isc::d2::D2CfgMgr::parse(), isc::ha::HAService::processContinue(), isc::ha::HAService::processHAReset(), isc::ha::HAService::processHeartbeat(), isc::ha::HAService::processMaintenanceCancel(), isc::ha::HAService::processMaintenanceNotify(), isc::ha::HAService::processMaintenanceStart(), isc::ha::HAService::processScopes(), isc::ha::HAService::processSyncCompleteNotify(), isc::config::CmdsImpl::setSuccessResponse(), isc::stats::StatsMgr::statisticGetAllHandler(), isc::stats::StatsMgr::statisticGetHandler(), isc::stats::StatsMgr::statisticRemoveAllHandler(), isc::stats::StatsMgr::statisticRemoveHandler(), isc::stats::StatsMgr::statisticResetAllHandler(), isc::stats::StatsMgr::statisticResetHandler(), isc::stats::StatsMgr::statisticSetMaxSampleAgeAllHandler(), isc::stats::StatsMgr::statisticSetMaxSampleAgeHandler(), isc::stats::StatsMgr::statisticSetMaxSampleCountAllHandler(), isc::stats::StatsMgr::statisticSetMaxSampleCountHandler(), isc::stat_cmds::LeaseStatCmdsImpl::statLease4GetHandler(), isc::stat_cmds::LeaseStatCmdsImpl::statLease6GetHandler(), isc::ha::HAService::synchronize(), isc::ha::HAService::syncingStateHandler(), isc::ha::HAService::verifyAsyncResponse(), and isc::netconf::NetconfAgent::yangConfig().

◆ CONTROL_SERVICE

const char * isc::config::CONTROL_SERVICE = "service"

String used for service list ("service")

Definition at line 29 of file command_interpreter.cc.

◆ CONTROL_TEXT

const char * isc::config::CONTROL_TEXT = "text"

String used for storing textual description ("text")

Definition at line 27 of file command_interpreter.cc.

Referenced by isc::config::CmdResponseCreator::filterCommand(), isc::agent::CtrlAgentCommandMgr::handleCommand(), and isc::ha::HAService::verifyAsyncResponse().

◆ DBG_COMMAND

◆ TIMEOUT_AGENT_FORWARD_COMMAND

constexpr long isc::config::TIMEOUT_AGENT_FORWARD_COMMAND = 60000

Timeout for the Control Agent to forward command to a Kea server, e.g.

DHCP server.

This value is high to ensure that the server have enough time to generate large responses, e.g. dump whole lease database.

Definition at line 31 of file timeouts.h.

Referenced by isc::netconf::HttpControlSocket::configSet(), isc::netconf::UnixControlSocket::configSet(), and isc::agent::CtrlAgentCommandMgr::handleCommand().

◆ TIMEOUT_AGENT_IDLE_CONNECTION_TIMEOUT

constexpr long isc::config::TIMEOUT_AGENT_IDLE_CONNECTION_TIMEOUT = 30000

Timeout for the idle connection to be closed.

Definition at line 24 of file timeouts.h.

Referenced by isc::agent::CtrlAgentProcess::configure(), and isc::config::CmdHttpListener::start().

◆ TIMEOUT_AGENT_RECEIVE_COMMAND

constexpr long isc::config::TIMEOUT_AGENT_RECEIVE_COMMAND = 10000

Timeout for the Control Agent to receive command over the RESTful interface.

Definition at line 21 of file timeouts.h.

Referenced by isc::agent::CtrlAgentProcess::configure(), and isc::config::CmdHttpListener::start().

◆ TIMEOUT_DEFAULT_HTTP_CLIENT_REQUEST

constexpr long isc::config::TIMEOUT_DEFAULT_HTTP_CLIENT_REQUEST = 10000

Timeout for the HTTP clients awaiting a response to a request.

This value is high to ensure that the client waits long enough for the fulfilling server to generate a response. Specified milliseconds.

Definition at line 38 of file timeouts.h.

Referenced by isc::ha::HAService::asyncDisableDHCPService(), isc::ha::HAService::asyncEnableDHCPService(), isc::ha::HAService::asyncSendHeartbeat(), isc::ha::HAService::asyncSendLeaseUpdate(), isc::ha::HAService::asyncSyncCompleteNotify(), isc::ha::HAService::processMaintenanceCancel(), and isc::ha::HAService::processMaintenanceStart().

◆ TIMEOUT_DHCP_SERVER_RECEIVE_COMMAND

constexpr long isc::config::TIMEOUT_DHCP_SERVER_RECEIVE_COMMAND = 10000

Timeout for the DHCP server to receive command over the unix domain socket.

Definition at line 17 of file timeouts.h.