[svn] commit: r1872 - /trunk/src/lib/config/config_data.h
BIND 10 source code commits
bind10-changes at lists.isc.org
Thu May 20 12:39:33 UTC 2010
Author: jelte
Date: Thu May 20 12:39:33 2010
New Revision: 1872
Log:
trivial update: added whitespace to header file as requested in review ticket 38
Modified:
trunk/src/lib/config/config_data.h
Modified: trunk/src/lib/config/config_data.h
==============================================================================
--- trunk/src/lib/config/config_data.h (original)
+++ trunk/src/lib/config/config_data.h Thu May 20 12:39:33 2010
@@ -40,6 +40,7 @@
/// Constructs a ConfigData option with no specification and an
/// empty configuration.
ConfigData() { _config = Element::createFromString("{}"); };
+
/// Constructs a ConfigData option with the given specification
/// and an empty configuration.
/// \param module_spec A ModuleSpec for the relevant module
@@ -70,17 +71,21 @@
/// Returns the ModuleSpec associated with this ConfigData object
const ModuleSpec getModuleSpec() { return _module_spec; };
+
/// Set the ModuleSpec associated with this ConfigData object
void setModuleSpec(ModuleSpec module_spec) { _module_spec = module_spec; };
+
/// Set the local configuration (i.e. all non-default values)
/// \param config An ElementPtr pointing to a MapElement containing
/// *all* non-default configuration values. Existing values
/// will be removed.
void setLocalConfig(ElementPtr config) { _config = config; }
+
/// Returns the local (i.e. non-default) configuration.
/// \returns An ElementPtr pointing to a MapElement containing all
/// non-default configuration options.
ElementPtr getLocalConfig() { return _config; }
+
/// Returns a list of all possible configuration options as specified
/// by the ModuleSpec.
/// \param identifier If given, show the items at the given identifier
@@ -92,6 +97,7 @@
/// location (or all possible identifiers if identifier==""
/// and recurse==false)
ElementPtr getItemList(const std::string& identifier = "", bool recurse = false);
+
/// Returns all current configuration settings (both non-default and default).
/// \return An ElementPtr pointing to a MapElement containing
/// string->value elements, where the string is the
More information about the bind10-changes
mailing list