///
/// This class is the base class for control socket communication.
/// Derived classes implement config-get, config-test and config-set
-/// using control sockets of different types.
+/// using control sockets of different types. Those classes are used to
+/// communicate with other Kea daemons.
class ControlSocketBase {
public:
return (socket_cfg_->getType());
}
- /// @brief Getter which returns the Unix socket name.
+ /// @brief Returns the Unix socket name.
///
/// @return returns the Unix socket name as a std::string.
const std::string getName() const {
return (socket_cfg_->getName());
}
- /// @brief Getter which returns the HTTP server URL.
+ /// @brief Returns the HTTP server URL.
///
/// @return returns the HTTP server URL as an isc::http::Url.
const isc::http::Url getUrl() const {
/// @brief Creates HTTP response.
///
/// Build a response with reflected request in a received JSON map.
- /// When wanted reply with partial JSON.
+ /// It can be told to respond with a partial JSON.
///
/// @param request Pointer to the HTTP request.
/// @return Pointer to an object representing HTTP response.
const char *CONTROL_RESULT = "result";
const char *CONTROL_TEXT = "text";
const char *CONTROL_ARGUMENTS = "arguments";
- const char *CONTROL_SERVICE = "service";
+const char *CONTROL_SERVICE = "service";
// Full version, with status, text and arguments
ConstElementPtr
/// @return printable string
std::string answerToText(const isc::data::ConstElementPtr& msg);
-/// @brief Creates a standard config/command command message with no
+/// @brief Creates a standard command message with no
/// argument (of the form { "command": "my_command" })
///
/// @param command The command string
/// @return The created message
isc::data::ConstElementPtr createCommand(const std::string& command);
-/// @brief Creates a standard config/command command message with the
+/// @brief Creates a standard command message with the
/// given argument (of the form { "command": "my_command", "arguments": arg }
///
/// @param command The command string