summaryrefslogtreecommitdiffstats
path: root/src/lib/process/d_controller.h
diff options
context:
space:
mode:
authorFrancis Dupont <fdupont@isc.org>2017-03-11 01:31:58 +0100
committerFrancis Dupont <fdupont@isc.org>2017-03-11 01:31:58 +0100
commit23319d1c41f4c021d45290e92f978ddd838a70b5 (patch)
tree7d1fdf05fc2f4dcd849c1b9ef041c341d10a0d4b /src/lib/process/d_controller.h
parent[master] Changelog updated (diff)
downloadkea-23319d1c41f4c021d45290e92f978ddd838a70b5.tar.xz
kea-23319d1c41f4c021d45290e92f978ddd838a70b5.zip
[master] Began -t support for D2/CA
Diffstat (limited to 'src/lib/process/d_controller.h')
-rw-r--r--src/lib/process/d_controller.h42
1 files changed, 30 insertions, 12 deletions
diff --git a/src/lib/process/d_controller.h b/src/lib/process/d_controller.h
index 6ba258a25a..a86be3b0ec 100644
--- a/src/lib/process/d_controller.h
+++ b/src/lib/process/d_controller.h
@@ -34,7 +34,7 @@ public:
/// Since command line argument parsing is done as part of
/// DControllerBase::launch(), it uses this exception to propagate
/// version information up to main(), when command line argument
-/// -v or -V is given.
+/// -v, -V or -W is given.
class VersionMessage : public isc::Exception {
public:
VersionMessage(const char* file, size_t line, const char* what) :
@@ -128,7 +128,7 @@ public:
/// arguments.
///
/// This function can be run in "test mode". It prevents initialization
- /// of D2 module logger. This is used in unit tests which initialize logger
+ /// of module logger. This is used in unit tests which initialize logger
/// in their main function. Such a logger uses environmental variables to
/// control severity, verbosity etc.
///
@@ -223,10 +223,10 @@ public:
/// @return an Element that contains the results of command composed
/// of an integer status value and a string explanation of the outcome.
/// The status value is one of the following:
- /// D2::COMMAND_SUCCESS - Command executed successfully
- /// D2::COMMAND_ERROR - Command is valid but suffered an operational
+ /// COMMAND_SUCCESS - Command executed successfully
+ /// COMMAND_ERROR - Command is valid but suffered an operational
/// failure.
- /// D2::COMMAND_INVALID - Command is not recognized as valid be either
+ /// COMMAND_INVALID - Command is not recognized as valid be either
/// the controller or the application process.
virtual isc::data::ConstElementPtr executeCommand(const std::string&
command,
@@ -283,10 +283,10 @@ protected:
/// @return an Element that contains the results of command composed
/// of an integer status value and a string explanation of the outcome.
/// The status value is one of the following:
- /// D2::COMMAND_SUCCESS - Command executed successfully
- /// D2::COMMAND_ERROR - Command is valid but suffered an operational
+ /// COMMAND_SUCCESS - Command executed successfully
+ /// COMMAND_ERROR - Command is valid but suffered an operational
/// failure.
- /// D2::COMMAND_INVALID - Command is not recognized as a valid custom
+ /// COMMAND_INVALID - Command is not recognized as a valid custom
/// controller command.
virtual isc::data::ConstElementPtr customControllerCommand(
const std::string& command, isc::data::ConstElementPtr args);
@@ -302,7 +302,7 @@ protected:
/// @brief Virtual method which returns a string containing the option
/// letters for any custom command line options supported by the derivation.
- /// These are added to the stock options of "c" and "v" during command
+ /// These are added to the stock options of "c", "d", ..., during command
/// line interpretation.
///
/// @return returns a string containing the custom option letters.
@@ -342,6 +342,20 @@ protected:
verbose_ = value;
}
+ /// @brief Supplies whether or not check only mode is enabled.
+ ///
+ /// @return returns true if check only is enabled.
+ bool isCheckOnly() const {
+ return (check_only_);
+ }
+
+ /// @brief Method for enabling or disabling check only mode.
+ ///
+ /// @param value is the new value to assign the flag.
+ void setCheckOnly(bool value) {
+ check_only_ = value;
+ }
+
/// @brief Getter for fetching the controller's IOService
///
/// @return returns a pointer reference to the IOService.
@@ -385,14 +399,15 @@ protected:
/// list of options with those returned by getCustomOpts(), and uses
/// cstdlib's getopt to loop through the command line.
/// It handles stock options directly, and passes any custom options into
- /// the customOption method. Currently there are only two stock options
- /// -c for specifying the configuration file, and -v for verbose logging.
+ /// the customOption method. Currently there are only some stock options
+ /// -c/t for specifying the configuration file, -d for verbose logging,
+ /// and -v/V/W for version reports.
///
/// @param argc is the number of command line arguments supplied
/// @param argv is the array of string (char *) command line arguments
///
/// @throw InvalidUsage when there are usage errors.
- /// @throw VersionMessage if the -v or -V arguments is given.
+ /// @throw VersionMessage if the -v, -V or -W arguments is given.
void parseArgs(int argc, char* argv[]);
@@ -536,6 +551,9 @@ private:
/// @brief Indicates if the verbose logging mode is enabled.
bool verbose_;
+ /// @brief Indicates if the check only mode is enabled.
+ bool check_only_;
+
/// @brief The absolute file name of the JSON spec file.
std::string spec_file_name_;