Kea 2.0.2
command_interpreter.h
Go to the documentation of this file.
1// Copyright (C) 2009-2018 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7#ifndef COMMAND_INTERPRETER_H
8#define COMMAND_INTERPRETER_H
9
10#include <cc/data.h>
11#include <string>
12
19
20namespace isc {
21namespace config {
22
24extern const char *CONTROL_COMMAND;
25
27extern const char *CONTROL_RESULT;
28
30extern const char *CONTROL_TEXT;
31
33extern const char *CONTROL_ARGUMENTS;
34
36extern const char *CONTROL_SERVICE;
37
40
43
46
51
55public:
56 CtrlChannelError(const char* file, size_t line, const char* what) :
57 isc::Exception(file, line, what) {}
58};
59
64
71isc::data::ConstElementPtr createAnswer(const int status_code,
72 const std::string& status_text);
73
83
92 const std::string& status,
94
102 const isc::data::ConstElementPtr& msg);
103
109
115isc::data::ConstElementPtr createCommand(const std::string& command);
116
124isc::data::ConstElementPtr createCommand(const std::string& command,
126
134 isc::data::ConstElementPtr createCommand(const std::string& command,
135 const std::string& service);
136
146isc::data::ConstElementPtr createCommand(const std::string& command,
148 const std::string& service);
149
162
163
180
196 const isc::data::ConstElementPtr& response2);
197
198}; // end of namespace isc::config
199}; // end of namespace isc
200
201#endif // COMMAND_INTERPRETER_H
This is a base class for exceptions thrown from the DNS library module.
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
A standard control channel exception that is thrown if a function is there is a problem with one of t...
CtrlChannelError(const char *file, size_t line, const char *what)
std::string parseCommandWithArgs(ConstElementPtr &arg, ConstElementPtr command)
const char * CONTROL_ARGUMENTS
String used for arguments map ("arguments")
const int CONTROL_RESULT_EMPTY
Status code indicating that the specified command was completed correctly, but failed to produce any ...
const char * CONTROL_TEXT
String used for storing textual description ("text")
const char * CONTROL_COMMAND
String used for commands ("command")
ConstElementPtr createCommand(const std::string &command)
Creates a standard command message with no argument (of the form { "command": "my_command" })
const int CONTROL_RESULT_ERROR
Status code indicating a general failure.
const char * CONTROL_SERVICE
String used for service list ("service")
std::string parseCommand(ConstElementPtr &arg, ConstElementPtr command)
ConstElementPtr combineCommandsLists(const ConstElementPtr &response1, const ConstElementPtr &response2)
const int CONTROL_RESULT_COMMAND_UNSUPPORTED
Status code indicating that the specified command is not supported.
ConstElementPtr createAnswer(const int status_code, const std::string &text, const ConstElementPtr &arg)
ConstElementPtr parseAnswer(int &rcode, const ConstElementPtr &msg)
const char * CONTROL_RESULT
String used for result, i.e. integer status ("result")
const int CONTROL_RESULT_SUCCESS
Status code indicating a successful operation.
std::string answerToText(const ConstElementPtr &msg)
boost::shared_ptr< const Element > ConstElementPtr
Definition: data.h:27
Defines the logger used by the top-level component of kea-lfc.