command_interpreter.h

Go to the documentation of this file.

// Copyright (C) 2009-2026 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
#ifndef COMMAND_INTERPRETER_H
#define COMMAND_INTERPRETER_H
 
#include <cc/data.h>
#include <string>

 
namespace isc {
namespace config {

extern const char *CONTROL_COMMAND;

extern const char *CONTROL_RESULT;

extern const char *CONTROL_TEXT;

extern const char *CONTROL_ARGUMENTS;

extern const char *CONTROL_SERVICE;

extern const char *CONTROL_REMOTE_ADDRESS;

const int CONTROL_RESULT_SUCCESS = 0;

const int CONTROL_RESULT_ERROR = 1;

const int CONTROL_RESULT_COMMAND_UNSUPPORTED = 2;

const int CONTROL_RESULT_EMPTY = 3;

const int CONTROL_RESULT_CONFLICT = 4;

const int CONTROL_RESULT_FATAL_ERROR = 5;

class CtrlChannelError : public isc::Exception {
public:
    CtrlChannelError(const char* file, size_t line, const char* what) :
        isc::Exception(file, line, what) {}
};

isc::data::ConstElementPtr createAnswer();

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

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

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

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

isc::data::ConstElementPtr
parseAnswerText(int &rcode, const isc::data::ConstElementPtr& msg);

std::string answerToText(const isc::data::ConstElementPtr& msg);

isc::data::ConstElementPtr createCommand(const std::string& command);

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

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

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

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

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

isc::data::ConstElementPtr
combineCommandsLists(const isc::data::ConstElementPtr& response1,
                     const isc::data::ConstElementPtr& response2);
 
}  // namespace config
}  // namespace isc
 
#endif // COMMAND_INTERPRETER_H