BIND 10 trac1555, updated. 9517e24b3bc274e4a8f080cb15358db8017c3f44 [1555] Trivial: fixed doxygen issues in dhcp_parsers.h.
BIND 10 source code commits
bind10-changes at lists.isc.org
Thu Jul 11 08:55:12 UTC 2013
The branch, trac1555 has been updated
via 9517e24b3bc274e4a8f080cb15358db8017c3f44 (commit)
via 42de7b42fd0fd6653489efe5412b34365d3a4a77 (commit)
from 339d60a7b7a5b83a2b9c5064af5d621e3047582f (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 9517e24b3bc274e4a8f080cb15358db8017c3f44
Author: Marcin Siodelski <marcin at isc.org>
Date: Thu Jul 11 10:54:55 2013 +0200
[1555] Trivial: fixed doxygen issues in dhcp_parsers.h.
commit 42de7b42fd0fd6653489efe5412b34365d3a4a77
Author: Marcin Siodelski <marcin at isc.org>
Date: Thu Jul 11 10:34:43 2013 +0200
[1555] Trivial: whitespace cleanup.
-----------------------------------------------------------------------
Summary of changes:
src/bin/dhcp4/config_parser.cc | 82 +++++++-------
src/bin/dhcp4/config_parser.h | 4 +-
src/bin/dhcp4/tests/config_parser_unittest.cc | 2 +-
src/bin/dhcp6/config_parser.cc | 80 +++++++-------
src/bin/dhcp6/config_parser.h | 6 +-
src/lib/dhcpsrv/dhcp_parsers.cc | 130 +++++++++++-----------
src/lib/dhcpsrv/dhcp_parsers.h | 137 ++++++++++++------------
src/lib/dhcpsrv/tests/dhcp_parsers_unittest.cc | 82 +++++++-------
8 files changed, 261 insertions(+), 262 deletions(-)
-----------------------------------------------------------------------
diff --git a/src/bin/dhcp4/config_parser.cc b/src/bin/dhcp4/config_parser.cc
index 57ebf58..726a4a6 100644
--- a/src/bin/dhcp4/config_parser.cc
+++ b/src/bin/dhcp4/config_parser.cc
@@ -53,10 +53,10 @@ public:
/// @param dummy first param, option names are always "Dhcp4/option-data[n]"
/// @param options is the option storage in which to store the parsed option
/// upon "commit".
- /// @param global_context is a pointer to the global context which
+ /// @param global_context is a pointer to the global context which
/// stores global scope parameters, options, option defintions.
- Dhcp4OptionDataParser(const std::string&,
- OptionStoragePtr options, ParserContextPtr global_context)
+ Dhcp4OptionDataParser(const std::string&,
+ OptionStoragePtr options, ParserContextPtr global_context)
:OptionDataParser("", options, global_context) {
}
@@ -64,7 +64,7 @@ public:
///
/// @param param_name name of the parameter to be parsed.
/// @param options storage where the parameter value is to be stored.
- /// @param global_context is a pointer to the global context which
+ /// @param global_context is a pointer to the global context which
/// stores global scope parameters, options, option defintions.
/// @return returns a pointer to a new OptionDataParser. Caller is
/// is responsible for deleting it when it is no longer needed.
@@ -75,16 +75,16 @@ public:
protected:
/// @brief Finds an option definition within the server's option space
- ///
- /// Given an option space and an option code, find the correpsonding
+ ///
+ /// Given an option space and an option code, find the correpsonding
/// option defintion within the server's option defintion storage.
///
- /// @param option_space name of the parameter option space
- /// @param option_code numeric value of the parameter to find
- /// @return OptionDefintionPtr of the option defintion or an
+ /// @param option_space name of the parameter option space
+ /// @param option_code numeric value of the parameter to find
+ /// @return OptionDefintionPtr of the option defintion or an
/// empty OptionDefinitionPtr if not found.
- /// @throw DhcpConfigError if the option space requested is not valid
- /// for this server.
+ /// @throw DhcpConfigError if the option space requested is not valid
+ /// for this server.
virtual OptionDefinitionPtr findServerSpaceOptionDefinition (
std::string& option_space, uint32_t option_code) {
OptionDefinitionPtr def;
@@ -100,11 +100,11 @@ protected:
}
};
-/// @brief Parser for IPv4 pool definitions.
+/// @brief Parser for IPv4 pool definitions.
///
-/// This is the IPv4 derivation of the PoolParser class and handles pool
-/// definitions, i.e. a list of entries of one of two syntaxes: min-max and
-/// prefix/len for IPv4 pools. Pool4 objects are created and stored in chosen
+/// This is the IPv4 derivation of the PoolParser class and handles pool
+/// definitions, i.e. a list of entries of one of two syntaxes: min-max and
+/// prefix/len for IPv4 pools. Pool4 objects are created and stored in chosen
/// PoolStorage container.
///
/// It is useful for parsing Dhcp4/subnet4[X]/pool parameters.
@@ -126,9 +126,9 @@ protected:
///
/// @param addr is the IPv4 prefix of the pool.
/// @param len is the prefix length.
- /// @param ignored dummy parameter to provide symmetry between the
+ /// @param ignored dummy parameter to provide symmetry between the
/// PoolParser derivations. The V6 derivation requires a third value.
- /// @return returns a PoolPtr to the new Pool4 object.
+ /// @return returns a PoolPtr to the new Pool4 object.
PoolPtr poolMaker (IOAddress &addr, uint32_t len, int32_t) {
return (PoolPtr(new Pool4(addr, len)));
}
@@ -137,9 +137,9 @@ protected:
///
/// @param min is the first IPv4 address in the pool.
/// @param max is the last IPv4 address in the pool.
- /// @param ignored dummy parameter to provide symmetry between the
+ /// @param ignored dummy parameter to provide symmetry between the
/// PoolParser derivations. The V6 derivation requires a third value.
- /// @return returns a PoolPtr to the new Pool4 object.
+ /// @return returns a PoolPtr to the new Pool4 object.
PoolPtr poolMaker (IOAddress &min, IOAddress &max, int32_t) {
return (PoolPtr(new Pool4(min, max)));
}
@@ -147,8 +147,8 @@ protected:
/// @brief This class parses a single IPv4 subnet.
///
-/// This is the IPv4 derivation of the SubnetConfigParser class and it parses
-/// the whole subnet definition. It creates parsersfor received configuration
+/// This is the IPv4 derivation of the SubnetConfigParser class and it parses
+/// the whole subnet definition. It creates parsersfor received configuration
/// parameters as needed.
class Subnet4ConfigParser : public SubnetConfigParser {
public:
@@ -158,7 +158,7 @@ public:
/// stores global scope parameters, options, option defintions.
Subnet4ConfigParser(const std::string&)
:SubnetConfigParser("", globalContext()) {
- }
+ }
/// @brief Adds the created subnet to a server's configuration.
/// @throw throws Unexpected if dynamic cast fails.
@@ -167,7 +167,7 @@ public:
Subnet4Ptr sub4ptr = boost::dynamic_pointer_cast<Subnet4>(subnet_);
if (!sub4ptr) {
// If we hit this, it is a programming error.
- isc_throw(Unexpected,
+ isc_throw(Unexpected,
"Invalid cast in Subnet4ConfigParser::commit");
}
@@ -191,13 +191,13 @@ protected:
(config_id.compare("renew-timer") == 0) ||
(config_id.compare("rebind-timer") == 0)) {
parser = new Uint32Parser(config_id, uint32_values_);
- } else if ((config_id.compare("subnet") == 0) ||
+ } else if ((config_id.compare("subnet") == 0) ||
(config_id.compare("interface") == 0)) {
parser = new StringParser(config_id, string_values_);
} else if (config_id.compare("pool") == 0) {
parser = new Pool4Parser(config_id, pools_);
} else if (config_id.compare("option-data") == 0) {
- parser = new OptionDataListParser(config_id, options_,
+ parser = new OptionDataListParser(config_id, options_,
global_context_,
Dhcp4OptionDataParser::factory);
} else {
@@ -210,7 +210,7 @@ protected:
/// @brief Determines if the given option space name and code describe
- /// a standard option for the DCHP4 server.
+ /// a standard option for the DCHP4 server.
///
/// @param option_space is the name of the option space to consider
/// @param code is the numeric option code to consider
@@ -230,12 +230,12 @@ protected:
}
/// @brief Issues a DHCP4 server specific warning regarding duplicate subnet
- /// options.
- ///
+ /// options.
+ ///
/// @param code is the numeric option code of the duplicate option
- /// @param addr is the subnet address
+ /// @param addr is the subnet address
/// @todo a means to know the correct logger and perhaps a common
- /// message would allow this method to be emitted by the base class.
+ /// message would allow this method to be emitted by the base class.
virtual void duplicate_option_warning(uint32_t code,
isc::asiolink::IOAddress& addr) {
LOG_WARN(dhcp4_logger, DHCP4_CONFIG_OPTION_DUPLICATE)
@@ -243,10 +243,10 @@ protected:
}
/// @brief Instantiates the IPv4 Subnet based on a given IPv4 address
- /// and prefix length.
- ///
+ /// and prefix length.
+ ///
/// @param addr is IPv4 address of the subnet.
- /// @param len is the prefix length
+ /// @param len is the prefix length
void initSubnet(isc::asiolink::IOAddress addr, uint8_t len) {
// Get all 'time' parameters using inheritance.
// If the subnet-specific value is defined then use it, else
@@ -338,32 +338,32 @@ namespace dhcp {
///
/// @param config_id pointer to received global configuration entry
/// @return parser for specified global DHCPv4 parameter
-/// @throw NotImplemented if trying to create a parser for unknown
+/// @throw NotImplemented if trying to create a parser for unknown
/// config element
DhcpConfigParser* createGlobalDhcp4ConfigParser(const std::string& config_id) {
DhcpConfigParser* parser = NULL;
if ((config_id.compare("valid-lifetime") == 0) ||
(config_id.compare("renew-timer") == 0) ||
(config_id.compare("rebind-timer") == 0)) {
- parser = new Uint32Parser(config_id,
+ parser = new Uint32Parser(config_id,
globalContext()->uint32_values_);
} else if (config_id.compare("interfaces") == 0) {
parser = new InterfaceListConfigParser(config_id);
} else if (config_id.compare("subnet4") == 0) {
parser = new Subnets4ListConfigParser(config_id);
} else if (config_id.compare("option-data") == 0) {
- parser = new OptionDataListParser(config_id,
- globalContext()->options_,
+ parser = new OptionDataListParser(config_id,
+ globalContext()->options_,
globalContext(),
Dhcp4OptionDataParser::factory);
} else if (config_id.compare("option-def") == 0) {
- parser = new OptionDefListParser(config_id,
+ parser = new OptionDefListParser(config_id,
globalContext()->option_defs_);
} else if (config_id.compare("version") == 0) {
- parser = new StringParser(config_id,
+ parser = new StringParser(config_id,
globalContext()->string_values_);
} else if (config_id.compare("lease-database") == 0) {
- parser = new DbAccessParser(config_id);
+ parser = new DbAccessParser(config_id);
} else {
isc_throw(NotImplemented,
"Parser error: Global configuration parameter not supported: "
@@ -384,7 +384,7 @@ configureDhcp4Server(Dhcpv4Srv&, isc::data::ConstElementPtr config_set) {
/// @todo: Append most essential info here (like "2 new subnets configured")
string config_details;
- LOG_DEBUG(dhcp4_logger, DBG_DHCP4_COMMAND,
+ LOG_DEBUG(dhcp4_logger, DBG_DHCP4_COMMAND,
DHCP4_CONFIG_START).arg(config_set->str());
// Some of the values specified in the configuration depend on
diff --git a/src/bin/dhcp4/config_parser.h b/src/bin/dhcp4/config_parser.h
index ea84cc6..3af9911 100644
--- a/src/bin/dhcp4/config_parser.h
+++ b/src/bin/dhcp4/config_parser.h
@@ -30,7 +30,7 @@ namespace dhcp {
class Dhcpv4Srv;
-/// @brief Configure DHCPv4 server (@c Dhcpv4Srv) with a set of configuration
+/// @brief Configure DHCPv4 server (@c Dhcpv4Srv) with a set of configuration
/// values.
///
/// This function parses configuration information stored in @c config_set
@@ -44,7 +44,7 @@ class Dhcpv4Srv;
/// (such as malformed configuration or invalid configuration parameter),
/// this function returns appropriate error code.
///
-/// This function is called every time a new configuration is received. The
+/// This function is called every time a new configuration is received. The
/// extra parameter is a reference to DHCPv4 server component. It is currently
/// not used and CfgMgr::instance() is accessed instead.
///
diff --git a/src/bin/dhcp4/tests/config_parser_unittest.cc b/src/bin/dhcp4/tests/config_parser_unittest.cc
index 6aae9f2..7c7caa2 100644
--- a/src/bin/dhcp4/tests/config_parser_unittest.cc
+++ b/src/bin/dhcp4/tests/config_parser_unittest.cc
@@ -56,7 +56,7 @@ public:
// Checks if global parameter of name have expected_value
void checkGlobalUint32(string name, uint32_t expected_value) {
- const Uint32StoragePtr uint32_defaults =
+ const Uint32StoragePtr uint32_defaults =
globalContext()->uint32_values_;
try {
uint32_t actual_value = uint32_defaults->getParam(name);
diff --git a/src/bin/dhcp6/config_parser.cc b/src/bin/dhcp6/config_parser.cc
index a5ef1f8..cc6bd02 100644
--- a/src/bin/dhcp6/config_parser.cc
+++ b/src/bin/dhcp6/config_parser.cc
@@ -67,10 +67,10 @@ public:
/// @param dummy first param, option names are always "Dhcp6/option-data[n]"
/// @param options is the option storage in which to store the parsed option
/// upon "commit".
- /// @param global_context is a pointer to the global context which
+ /// @param global_context is a pointer to the global context which
/// stores global scope parameters, options, option defintions.
- Dhcp6OptionDataParser(const std::string&, OptionStoragePtr options,
- ParserContextPtr global_context)
+ Dhcp6OptionDataParser(const std::string&, OptionStoragePtr options,
+ ParserContextPtr global_context)
:OptionDataParser("", options, global_context) {
}
@@ -78,7 +78,7 @@ public:
///
/// @param param_name name of the parameter to be parsed.
/// @param options storage where the parameter value is to be stored.
- /// @param global_context is a pointer to the global context which
+ /// @param global_context is a pointer to the global context which
/// stores global scope parameters, options, option defintions.
/// @return returns a pointer to a new OptionDataParser. Caller is
/// is responsible for deleting it when it is no longer needed.
@@ -90,16 +90,16 @@ public:
protected:
/// @brief Finds an option definition within the server's option space
- ///
- /// Given an option space and an option code, find the correpsonding
+ ///
+ /// Given an option space and an option code, find the correpsonding
/// option defintion within the server's option defintion storage.
///
- /// @param option_space name of the parameter option space
- /// @param option_code numeric value of the parameter to find
- /// @return OptionDefintionPtr of the option defintion or an
+ /// @param option_space name of the parameter option space
+ /// @param option_code numeric value of the parameter to find
+ /// @return OptionDefintionPtr of the option defintion or an
/// empty OptionDefinitionPtr if not found.
- /// @throw DhcpConfigError if the option space requested is not valid
- /// for this server.
+ /// @throw DhcpConfigError if the option space requested is not valid
+ /// for this server.
virtual OptionDefinitionPtr findServerSpaceOptionDefinition (
std::string& option_space, uint32_t option_code) {
OptionDefinitionPtr def;
@@ -115,11 +115,11 @@ protected:
}
};
-/// @brief Parser for IPv4 pool definitions.
+/// @brief Parser for IPv4 pool definitions.
///
-/// This is the IPv6 derivation of the PoolParser class and handles pool
-/// definitions, i.e. a list of entries of one of two syntaxes: min-max and
-/// prefix/len for IPv6 pools. Pool6 objects are created and stored in chosen
+/// This is the IPv6 derivation of the PoolParser class and handles pool
+/// definitions, i.e. a list of entries of one of two syntaxes: min-max and
+/// prefix/len for IPv6 pools. Pool6 objects are created and stored in chosen
/// PoolStorage container.
///
/// It is useful for parsing Dhcp6/subnet6[X]/pool parameters.
@@ -142,9 +142,9 @@ protected:
/// @param addr is the IPv6 prefix of the pool.
/// @param len is the prefix length.
/// @param ptype is the type of IPv6 pool (Pool6::Pool6Type). Note this is
- /// passed in as an int32_t and cast to Pool6Type to accommodate a
+ /// passed in as an int32_t and cast to Pool6Type to accommodate a
/// polymorphic interface.
- /// @return returns a PoolPtr to the new Pool4 object.
+ /// @return returns a PoolPtr to the new Pool4 object.
PoolPtr poolMaker (IOAddress &addr, uint32_t len, int32_t ptype)
{
return (PoolPtr(new Pool6(static_cast<isc::dhcp::Pool6::Pool6Type>
@@ -156,9 +156,9 @@ protected:
/// @param min is the first IPv6 address in the pool.
/// @param max is the last IPv6 address in the pool.
/// @param ptype is the type of IPv6 pool (Pool6::Pool6Type). Note this is
- /// passed in as an int32_t and cast to Pool6Type to accommodate a
+ /// passed in as an int32_t and cast to Pool6Type to accommodate a
/// polymorphic interface.
- /// @return returns a PoolPtr to the new Pool4 object.
+ /// @return returns a PoolPtr to the new Pool4 object.
PoolPtr poolMaker (IOAddress &min, IOAddress &max, int32_t ptype)
{
return (PoolPtr(new Pool6(static_cast<isc::dhcp::Pool6::Pool6Type>
@@ -168,8 +168,8 @@ protected:
/// @brief This class parses a single IPv6 subnet.
///
-/// This is the IPv6 derivation of the SubnetConfigParser class and it parses
-/// the whole subnet definition. It creates parsersfor received configuration
+/// This is the IPv6 derivation of the SubnetConfigParser class and it parses
+/// the whole subnet definition. It creates parsersfor received configuration
/// parameters as needed.
class Subnet6ConfigParser : public SubnetConfigParser {
public:
@@ -178,7 +178,7 @@ public:
///
/// @param ignored first parameter
/// stores global scope parameters, options, option defintions.
- Subnet6ConfigParser(const std::string&)
+ Subnet6ConfigParser(const std::string&)
:SubnetConfigParser("", globalContext()) {
}
@@ -220,7 +220,7 @@ protected:
} else if (config_id.compare("pool") == 0) {
parser = new Pool6Parser(config_id, pools_);
} else if (config_id.compare("option-data") == 0) {
- parser = new OptionDataListParser(config_id, options_,
+ parser = new OptionDataListParser(config_id, options_,
global_context_,
Dhcp6OptionDataParser::factory);
} else {
@@ -233,14 +233,14 @@ protected:
/// @brief Determines if the given option space name and code describe
- /// a standard option for the DHCP6 server.
+ /// a standard option for the DHCP6 server.
///
/// @param option_space is the name of the option space to consider
/// @param code is the numeric option code to consider
/// @return returns true if the space and code are part of the server's
/// standard options.
bool isServerStdOption(std::string option_space, uint32_t code) {
- return ((option_space.compare("dhcp6") == 0)
+ return ((option_space.compare("dhcp6") == 0)
&& LibDHCP::isStandardOption(Option::V6, code));
}
@@ -253,23 +253,23 @@ protected:
}
/// @brief Issues a DHCP6 server specific warning regarding duplicate subnet
- /// options.
- ///
+ /// options.
+ ///
/// @param code is the numeric option code of the duplicate option
/// @param addr is the subnet address
/// @todo A means to know the correct logger and perhaps a common
/// message would allow this message to be emitted by the base class.
- virtual void duplicate_option_warning(uint32_t code,
+ virtual void duplicate_option_warning(uint32_t code,
isc::asiolink::IOAddress& addr) {
LOG_WARN(dhcp6_logger, DHCP6_CONFIG_OPTION_DUPLICATE)
.arg(code).arg(addr.toText());
}
/// @brief Instantiates the IPv6 Subnet based on a given IPv6 address
- /// and prefix length.
- ///
+ /// and prefix length.
+ ///
/// @param addr is IPv6 prefix of the subnet.
- /// @param len is the prefix length
+ /// @param len is the prefix length
void initSubnet(isc::asiolink::IOAddress addr, uint8_t len) {
// Get all 'time' parameters using inheritance.
// If the subnet-specific value is defined then use it, else
@@ -292,13 +292,13 @@ protected:
// Specifying both interface for locally reachable subnets and
// interface id for relays is mutually exclusive. Need to test for
- // this condition.
+ // this condition.
if (!ifaceid.empty()) {
std::string iface;
try {
iface = string_values_->getParam("interface");
} catch (const DhcpConfigError &) {
- // iface not mandatory
+ // iface not mandatory
}
if (!iface.empty()) {
@@ -403,7 +403,7 @@ namespace dhcp {
///
/// @param config_id pointer to received global configuration entry
/// @return parser for specified global DHCPv6 parameter
-/// @throw NotImplemented if trying to create a parser for unknown config
+/// @throw NotImplemented if trying to create a parser for unknown config
/// element
DhcpConfigParser* createGlobal6DhcpConfigParser(const std::string& config_id) {
DhcpConfigParser* parser = NULL;
@@ -411,22 +411,22 @@ DhcpConfigParser* createGlobal6DhcpConfigParser(const std::string& config_id) {
(config_id.compare("valid-lifetime") == 0) ||
(config_id.compare("renew-timer") == 0) ||
(config_id.compare("rebind-timer") == 0)) {
- parser = new Uint32Parser(config_id,
+ parser = new Uint32Parser(config_id,
globalContext()->uint32_values_);
} else if (config_id.compare("interfaces") == 0) {
parser = new InterfaceListConfigParser(config_id);
} else if (config_id.compare("subnet6") == 0) {
parser = new Subnets6ListConfigParser(config_id);
} else if (config_id.compare("option-data") == 0) {
- parser = new OptionDataListParser(config_id,
- globalContext()->options_,
+ parser = new OptionDataListParser(config_id,
+ globalContext()->options_,
globalContext(),
Dhcp6OptionDataParser::factory);
} else if (config_id.compare("option-def") == 0) {
- parser = new OptionDefListParser(config_id,
+ parser = new OptionDefListParser(config_id,
globalContext()->option_defs_);
} else if (config_id.compare("version") == 0) {
- parser = new StringParser(config_id,
+ parser = new StringParser(config_id,
globalContext()->string_values_);
} else if (config_id.compare("lease-database") == 0) {
parser = new DbAccessParser(config_id);
@@ -450,7 +450,7 @@ configureDhcp6Server(Dhcpv6Srv&, isc::data::ConstElementPtr config_set) {
/// @todo: Append most essential info here (like "2 new subnets configured")
string config_details;
- LOG_DEBUG(dhcp6_logger, DBG_DHCP6_COMMAND,
+ LOG_DEBUG(dhcp6_logger, DBG_DHCP6_COMMAND,
DHCP6_CONFIG_START).arg(config_set->str());
// Some of the values specified in the configuration depend on
diff --git a/src/bin/dhcp6/config_parser.h b/src/bin/dhcp6/config_parser.h
index 2dce79e..bd571af 100644
--- a/src/bin/dhcp6/config_parser.h
+++ b/src/bin/dhcp6/config_parser.h
@@ -31,8 +31,8 @@ class Dhcpv6Srv;
/// @brief Configures DHCPv6 server
///
-/// This function is called every time a new configuration is received. The
-/// extra parameter is a reference to DHCPv6 server component. It is currently
+/// This function is called every time a new configuration is received. The
+/// extra parameter is a reference to DHCPv6 server component. It is currently
/// not used and CfgMgr::instance() is accessed instead.
///
/// This method does not throw. It catches all exceptions and returns them as
@@ -53,7 +53,7 @@ configureDhcp6Server(Dhcpv6Srv& server, isc::data::ConstElementPtr config_set);
///
/// @returns a reference to the global context
ParserContextPtr& globalContext();
-
+
}; // end of isc::dhcp namespace
}; // end of isc namespace
diff --git a/src/lib/dhcpsrv/dhcp_parsers.cc b/src/lib/dhcpsrv/dhcp_parsers.cc
index e94b49c..04cf508 100644
--- a/src/lib/dhcpsrv/dhcp_parsers.cc
+++ b/src/lib/dhcpsrv/dhcp_parsers.cc
@@ -57,17 +57,17 @@ ParserContext::ParserContext(const ParserContext& rhs):
universe_(rhs.universe_) {
}
-ParserContext&
+ParserContext&
ParserContext::operator=(const ParserContext& rhs) {
if (this != &rhs) {
- boolean_values_ =
+ boolean_values_ =
BooleanStoragePtr(new BooleanStorage(*(rhs.boolean_values_)));
- uint32_values_ =
+ uint32_values_ =
Uint32StoragePtr(new Uint32Storage(*(rhs.uint32_values_)));
- string_values_ =
+ string_values_ =
StringStoragePtr(new StringStorage(*(rhs.string_values_)));
options_ = OptionStoragePtr(new OptionStorage(*(rhs.options_)));
- option_defs_ =
+ option_defs_ =
OptionDefStoragePtr(new OptionDefStorage(*(rhs.option_defs_)));
universe_ = rhs.universe_;
}
@@ -81,14 +81,14 @@ DebugParser::DebugParser(const std::string& param_name)
:param_name_(param_name) {
}
-void
+void
DebugParser::build(ConstElementPtr new_config) {
value_ = new_config;
std::cout << "Build for token: [" << param_name_ << "] = ["
- << value_->str() << "]" << std::endl;
+ << value_->str() << "]" << std::endl;
}
-void
+void
DebugParser::commit() {
// Debug message. The whole DebugParser class is used only for parser
// debugging, and is not used in production code. It is very convenient
@@ -106,7 +106,7 @@ template<> void ValueParser<bool>::build(isc::data::ConstElementPtr value) {
try {
value_ = value->boolValue();
} catch (const isc::data::TypeError &) {
- isc_throw(BadValue, " Wrong value type for " << param_name_
+ isc_throw(BadValue, " Wrong value type for " << param_name_
<< " : build called with a non-boolean element.");
}
}
@@ -233,22 +233,22 @@ OptionDataParser::OptionDataParser(const std::string&, OptionStoragePtr options,
}
}
-void
+void
OptionDataParser::build(ConstElementPtr option_data_entries) {
BOOST_FOREACH(ConfigPair param, option_data_entries->mapValue()) {
ParserPtr parser;
if (param.first == "name" || param.first == "data" ||
param.first == "space") {
- StringParserPtr name_parser(new StringParser(param.first,
- string_values_));
+ StringParserPtr name_parser(new StringParser(param.first,
+ string_values_));
parser = name_parser;
} else if (param.first == "code") {
- Uint32ParserPtr code_parser(new Uint32Parser(param.first,
- uint32_values_));
+ Uint32ParserPtr code_parser(new Uint32Parser(param.first,
+ uint32_values_));
parser = code_parser;
} else if (param.first == "csv-format") {
- BooleanParserPtr value_parser(new BooleanParser(param.first,
- boolean_values_));
+ BooleanParserPtr value_parser(new BooleanParser(param.first,
+ boolean_values_));
parser = value_parser;
} else {
isc_throw(DhcpConfigError,
@@ -270,12 +270,12 @@ OptionDataParser::build(ConstElementPtr option_data_entries) {
createOption();
}
-void
+void
OptionDataParser::commit() {
if (!option_descriptor_.option) {
- // Before we can commit the new option should be configured. If it is
+ // Before we can commit the new option should be configured. If it is
// not than somebody must have called commit() before build().
- isc_throw(isc::InvalidOperation,
+ isc_throw(isc::InvalidOperation,
"parser logic error: no option has been configured and"
" thus there is nothing to commit. Has build() been called?");
}
@@ -299,7 +299,7 @@ OptionDataParser::commit() {
options_->addItem(option_descriptor_, option_space_);
}
-void
+void
OptionDataParser::createOption() {
// Option code is held in the uint32_t storage but is supposed to
// be uint16_t value. We need to check that value in the configuration
@@ -316,7 +316,7 @@ OptionDataParser::createOption() {
// Check that the option name has been specified, is non-empty and does not
// contain spaces
- std::string option_name = string_values_->getParam("name");
+ std::string option_name = string_values_->getParam("name");
if (option_name.empty()) {
isc_throw(DhcpConfigError, "name of the option with code '"
<< option_code << "' is empty");
@@ -325,7 +325,7 @@ OptionDataParser::createOption() {
<< "', space character is not allowed");
}
- std::string option_space = string_values_->getParam("space");
+ std::string option_space = string_values_->getParam("space");
if (!OptionSpace::validateName(option_space)) {
isc_throw(DhcpConfigError, "invalid option space name '"
<< option_space << "' specified for option '"
@@ -341,7 +341,7 @@ OptionDataParser::createOption() {
// need to search for its definition among user-configured
// options. They are expected to be in the global storage
// already.
- OptionDefContainerPtr defs =
+ OptionDefContainerPtr defs =
global_context_->option_defs_->getItems(option_space);
// The getItems() should never return the NULL pointer. If there are
@@ -395,16 +395,16 @@ OptionDataParser::createOption() {
<< " does not have a definition.");
}
- // @todo We have a limited set of option definitions intiialized at
- // the moment. In the future we want to initialize option definitions
- // for all options. Consequently an error will be issued if an option
+ // @todo We have a limited set of option definitions intiialized at
+ // the moment. In the future we want to initialize option definitions
+ // for all options. Consequently an error will be issued if an option
// definition does not exist for a particular option code. For now it is
// ok to create generic option if definition does not exist.
- OptionPtr option(new Option(global_context_->universe_,
+ OptionPtr option(new Option(global_context_->universe_,
static_cast<uint16_t>(option_code), binary));
- // The created option is stored in option_descriptor_ class member
- // until the commit stage when it is inserted into the main storage.
- // If an option with the same code exists in main storage already the
+ // The created option is stored in option_descriptor_ class member
+ // until the commit stage when it is inserted into the main storage.
+ // If an option with the same code exists in main storage already the
// old option is replaced.
option_descriptor_.option = option;
option_descriptor_.persistent = false;
@@ -426,9 +426,9 @@ OptionDataParser::createOption() {
// an instance of our option.
try {
OptionPtr option = csv_format ?
- def->optionFactory(global_context_->universe_,
+ def->optionFactory(global_context_->universe_,
option_code, data_tokens) :
- def->optionFactory(global_context_->universe_,
+ def->optionFactory(global_context_->universe_,
option_code, binary);
Subnet::OptionDescriptor desc(option, false);
option_descriptor_.option = option;
@@ -446,10 +446,10 @@ OptionDataParser::createOption() {
}
// **************************** OptionDataListParser *************************
-OptionDataListParser::OptionDataListParser(const std::string&,
+OptionDataListParser::OptionDataListParser(const std::string&,
OptionStoragePtr options, ParserContextPtr global_context,
OptionDataParserFactory* optionDataParserFactory)
- : options_(options), local_options_(new OptionStorage()),
+ : options_(options), local_options_(new OptionStorage()),
global_context_(global_context),
optionDataParserFactory_(optionDataParserFactory) {
if (!options_) {
@@ -468,11 +468,11 @@ OptionDataListParser::OptionDataListParser(const std::string&,
}
}
-void
+void
OptionDataListParser::build(ConstElementPtr option_data_list) {
BOOST_FOREACH(ConstElementPtr option_value, option_data_list->listValue()) {
- boost::shared_ptr<OptionDataParser>
- parser((*optionDataParserFactory_)("option-data",
+ boost::shared_ptr<OptionDataParser>
+ parser((*optionDataParserFactory_)("option-data",
local_options_, global_context_));
// options_ member will hold instances of all options thus
@@ -484,7 +484,7 @@ OptionDataListParser::build(ConstElementPtr option_data_list) {
}
}
-void
+void
OptionDataListParser::commit() {
BOOST_FOREACH(ParserPtr parser, parsers_) {
parser->commit();
@@ -497,7 +497,7 @@ OptionDataListParser::commit() {
}
// ******************************** OptionDefParser ****************************
-OptionDefParser::OptionDefParser(const std::string&,
+OptionDefParser::OptionDefParser(const std::string&,
OptionDefStoragePtr storage)
: storage_(storage), boolean_values_(new BooleanStorage()),
string_values_(new StringStorage()), uint32_values_(new Uint32Storage()) {
@@ -507,23 +507,23 @@ OptionDefParser::OptionDefParser(const std::string&,
}
}
-void
+void
OptionDefParser::build(ConstElementPtr option_def) {
// Parse the elements that make up the option definition.
BOOST_FOREACH(ConfigPair param, option_def->mapValue()) {
std::string entry(param.first);
ParserPtr parser;
- if (entry == "name" || entry == "type" || entry == "record-types"
+ if (entry == "name" || entry == "type" || entry == "record-types"
|| entry == "space" || entry == "encapsulate") {
- StringParserPtr str_parser(new StringParser(entry,
+ StringParserPtr str_parser(new StringParser(entry,
string_values_));
parser = str_parser;
} else if (entry == "code") {
- Uint32ParserPtr code_parser(new Uint32Parser(entry,
+ Uint32ParserPtr code_parser(new Uint32Parser(entry,
uint32_values_));
parser = code_parser;
} else if (entry == "array") {
- BooleanParserPtr array_parser(new BooleanParser(entry,
+ BooleanParserPtr array_parser(new BooleanParser(entry,
boolean_values_));
parser = array_parser;
} else {
@@ -555,7 +555,7 @@ OptionDefParser::build(ConstElementPtr option_def) {
}
}
-void
+void
OptionDefParser::commit() {
if (storage_ && option_definition_ &&
OptionSpace::validateName(option_space_name_)) {
@@ -563,7 +563,7 @@ OptionDefParser::commit() {
}
}
-void
+void
OptionDefParser::createOptionDef() {
// Get the option space name and validate it.
std::string space = string_values_->getParam("space");
@@ -643,7 +643,7 @@ OptionDefParser::createOptionDef() {
}
// ******************************** OptionDefListParser ************************
-OptionDefListParser::OptionDefListParser(const std::string&,
+OptionDefListParser::OptionDefListParser(const std::string&,
OptionDefStoragePtr storage) :storage_(storage) {
if (!storage_) {
isc_throw(isc::dhcp::DhcpConfigError, "parser logic error:"
@@ -651,7 +651,7 @@ OptionDefListParser::OptionDefListParser(const std::string&,
}
}
-void
+void
OptionDefListParser::build(ConstElementPtr option_def_list) {
// Clear existing items in the storage.
// We are going to replace all of them.
@@ -670,7 +670,7 @@ OptionDefListParser::build(ConstElementPtr option_def_list) {
}
}
-void
+void
OptionDefListParser::commit() {
CfgMgr& cfg_mgr = CfgMgr::instance();
cfg_mgr.deleteOptionDefs();
@@ -702,7 +702,7 @@ PoolParser::PoolParser(const std::string&, PoolStoragePtr pools)
}
}
-void
+void
PoolParser::build(ConstElementPtr pools_list) {
BOOST_FOREACH(ConstElementPtr text_pool, pools_list->listValue()) {
// That should be a single pool representation. It should contain
@@ -730,7 +730,7 @@ PoolParser::build(ConstElementPtr pools_list) {
// will result in interpreting the first digit as output
// value and throwing exception if length is written on two
// digits (because there are extra characters left over).
-
+
// No checks for values over 128. Range correctness will
// be checked in Pool4 constructor.
len = boost::lexical_cast<int>(prefix_len);
@@ -762,7 +762,7 @@ PoolParser::build(ConstElementPtr pools_list) {
}
}
-void
+void
PoolParser::commit() {
if (pools_) {
// local_pools_ holds the values produced by the build function.
@@ -774,9 +774,9 @@ PoolParser::commit() {
//****************************** SubnetConfigParser *************************
-SubnetConfigParser::SubnetConfigParser(const std::string&,
- ParserContextPtr global_context)
- : uint32_values_(new Uint32Storage()), string_values_(new StringStorage()),
+SubnetConfigParser::SubnetConfigParser(const std::string&,
+ ParserContextPtr global_context)
+ : uint32_values_(new Uint32Storage()), string_values_(new StringStorage()),
pools_(new PoolStorage()), options_(new OptionStorage()),
global_context_(global_context) {
// The first parameter should always be "subnet", but we don't check
@@ -787,7 +787,7 @@ SubnetConfigParser::SubnetConfigParser(const std::string&,
}
}
-void
+void
SubnetConfigParser::build(ConstElementPtr subnet) {
BOOST_FOREACH(ConfigPair param, subnet->mapValue()) {
ParserPtr parser(createSubnetConfigParser(param.first));
@@ -811,8 +811,8 @@ SubnetConfigParser::build(ConstElementPtr subnet) {
createSubnet();
}
-void
-SubnetConfigParser::appendSubOptions(const std::string& option_space,
+void
+SubnetConfigParser::appendSubOptions(const std::string& option_space,
OptionPtr& option) {
// Only non-NULL options are stored in option container.
// If this option pointer is NULL this is a serious error.
@@ -866,7 +866,7 @@ SubnetConfigParser::appendSubOptions(const std::string& option_space,
}
}
-void
+void
SubnetConfigParser::createSubnet() {
std::string subnet_txt;
try {
@@ -897,11 +897,11 @@ SubnetConfigParser::createSubnet() {
isc::asiolink::IOAddress addr(subnet_txt.substr(0, pos));
uint8_t len = boost::lexical_cast<unsigned int>(subnet_txt.substr(pos + 1));
- // Call the subclass's method to instantiate the subnet
+ // Call the subclass's method to instantiate the subnet
initSubnet(addr, len);
// Add pools to it.
- for (PoolStorage::iterator it = pools_->begin(); it != pools_->end();
+ for (PoolStorage::iterator it = pools_->begin(); it != pools_->end();
++it) {
subnet_->addPool(*it);
}
@@ -976,7 +976,7 @@ SubnetConfigParser::createSubnet() {
// values we don't add option from the global storage
// if there is one already.
Subnet::OptionDescriptor existing_desc =
- subnet_->getOptionDescriptor(option_space,
+ subnet_->getOptionDescriptor(option_space,
desc.option->getType());
if (!existing_desc.option) {
// Add sub-options (if any).
@@ -987,15 +987,15 @@ SubnetConfigParser::createSubnet() {
}
}
-isc::dhcp::Triplet<uint32_t>
+isc::dhcp::Triplet<uint32_t>
SubnetConfigParser::getParam(const std::string& name) {
uint32_t value = 0;
try {
- // look for local value
+ // look for local value
value = uint32_values_->getParam(name);
} catch (const DhcpConfigError &) {
try {
- // no local, use global value
+ // no local, use global value
value = global_context_->uint32_values_->getParam(name);
} catch (const DhcpConfigError &) {
isc_throw(DhcpConfigError, "Mandatory parameter " << name
diff --git a/src/lib/dhcpsrv/dhcp_parsers.h b/src/lib/dhcpsrv/dhcp_parsers.h
index 5551133..37dc950 100644
--- a/src/lib/dhcpsrv/dhcp_parsers.h
+++ b/src/lib/dhcpsrv/dhcp_parsers.h
@@ -47,8 +47,8 @@ typedef boost::shared_ptr<OptionStorage> OptionStoragePtr;
/// @brief A template class that stores named elements of a given data type.
///
/// This template class is provides data value storage for configuration parameters
-/// of a given data type. The values are stored by parameter name and as instances
-/// of type "ValueType".
+/// of a given data type. The values are stored by parameter name and as instances
+/// of type "ValueType".
///
/// @param ValueType is the data type of the elements to store.
template<typename ValueType>
@@ -57,7 +57,7 @@ class ValueStorage {
/// @brief Stores the the parameter and its value in the store.
///
/// If the parameter does not exist in the store, then it will be added,
- /// otherwise its data value will be updated with the given value.
+ /// otherwise its data value will be updated with the given value.
///
/// @param name is the name of the paramater to store.
/// @param value is the data value to store.
@@ -71,10 +71,10 @@ class ValueStorage {
/// @param name is the name of the parameter for which the data
/// value is desired.
///
- /// @return The paramater's data value of type <ValueType>.
+ /// @return The paramater's data value of type @c ValueType.
/// @throw DhcpConfigError if the parameter is not found.
ValueType getParam(const std::string& name) const {
- typename std::map<std::string, ValueType>::const_iterator param
+ typename std::map<std::string, ValueType>::const_iterator param
= values_.find(name);
if (param == values_.end()) {
@@ -87,8 +87,8 @@ class ValueStorage {
/// @brief Remove the parameter from the store.
///
- /// Deletes the entry for the given parameter from the store if it
- /// exists.
+ /// Deletes the entry for the given parameter from the store if it
+ /// exists.
///
/// @param name is the name of the paramater to delete.
void delParam(const std::string& name) {
@@ -108,7 +108,7 @@ class ValueStorage {
};
-/// @brief a collection of elements that store uint32 values
+/// @brief a collection of elements that store uint32 values
typedef ValueStorage<uint32_t> Uint32Storage;
typedef boost::shared_ptr<Uint32Storage> Uint32StoragePtr;
@@ -128,9 +128,9 @@ typedef boost::shared_ptr<BooleanStorage> BooleanStoragePtr;
class ParserContext {
public:
/// @brief Constructor
- ///
+ ///
/// @param universe is the Option::Universe value of this
- /// context.
+ /// context.
ParserContext(Option::Universe universe);
/// @brief Copy constructor
@@ -161,12 +161,12 @@ public:
/// @brief Pointer to various parser context.
typedef boost::shared_ptr<ParserContext> ParserContextPtr;
-/// @brief Simple data-type parser template class
+/// @brief Simple data-type parser template class
///
/// This is the template class for simple data-type parsers. It supports
-/// parsing a configuration parameter with specific data-type for its
-/// possible values. It provides a common constructor, commit, and templated
-/// data storage. The "build" method implementation must be provided by a
+/// parsing a configuration parameter with specific data-type for its
+/// possible values. It provides a common constructor, commit, and templated
+/// data storage. The "build" method implementation must be provided by a
/// declaring type.
/// @param ValueType is the data type of the configuration paramater value
/// the parser should handle.
@@ -182,7 +182,7 @@ public:
/// @throw isc::dhcp::DhcpConfigError if a provided parameter's
/// name is empty.
/// @throw isc::dhcp::DhcpConfigError if storage is null.
- ValueParser(const std::string& param_name,
+ ValueParser(const std::string& param_name,
boost::shared_ptr<ValueStorage<ValueType> > storage)
: storage_(storage), param_name_(param_name), value_() {
// Empty parameter name is invalid.
@@ -199,12 +199,12 @@ public:
}
- /// @brief Parse a given element into a value of type <ValueType>
+ /// @brief Parse a given element into a value of type @c ValueType
///
/// @param value a value to be parsed.
///
/// @throw isc::BadValue Typically the implementing type will throw
- /// a BadValue exception when given an invalid Element to parse.
+ /// a BadValue exception when given an invalid Element to parse.
void build(isc::data::ConstElementPtr value);
/// @brief Put a parsed value to the storage.
@@ -213,7 +213,7 @@ public:
// its value. If it doesn't we insert a new element.
storage_->setParam(param_name_, value_);
}
-
+
private:
/// Pointer to the storage where committed value is stored.
boost::shared_ptr<ValueStorage<ValueType> > storage_;
@@ -347,11 +347,11 @@ public:
/// @param dummy first argument is ignored, all Parser constructors
/// accept string as first argument.
/// @param options is the option storage in which to store the parsed option
- /// upon "commit".
- /// @param global_context is a pointer to the global context which
- /// stores global scope parameters, options, option defintions.
+ /// upon "commit".
+ /// @param global_context is a pointer to the global context which
+ /// stores global scope parameters, options, option defintions.
/// @throw isc::dhcp::DhcpConfigError if options or global_context are null.
- OptionDataParser(const std::string&, OptionStoragePtr options,
+ OptionDataParser(const std::string& dummy, OptionStoragePtr options,
ParserContextPtr global_context);
/// @brief Parses the single option data.
@@ -371,31 +371,31 @@ public:
/// @brief Commits option value.
///
- /// This function adds a new option to the storage or replaces an existing
+ /// This function adds a new option to the storage or replaces an existing
/// option with the same code.
///
- /// @throw isc::InvalidOperation if failed to set pointer to storage or
+ /// @throw isc::InvalidOperation if failed to set pointer to storage or
/// failed
/// to call build() prior to commit. If that happens data in the storage
/// remain un-modified.
virtual void commit();
- /// @brief virtual destructor to ensure orderly destruction of derivations.
+ /// @brief virtual destructor to ensure orderly destruction of derivations.
virtual ~OptionDataParser(){};
protected:
/// @brief Finds an option definition within the server's option space
- ///
- /// Given an option space and an option code, find the correpsonding
+ ///
+ /// Given an option space and an option code, find the correpsonding
/// option defintion within the server's option defintion storage. This
/// method is pure virtual requiring derivations to manage which option
/// space(s) is valid for search.
///
- /// @param option_space name of the parameter option space
- /// @param option_code numeric value of the parameter to find
- /// @return OptionDefintionPtr of the option defintion or an
+ /// @param option_space name of the parameter option space
+ /// @param option_code numeric value of the parameter to find
+ /// @return OptionDefintionPtr of the option defintion or an
/// empty OptionDefinitionPtr if not found.
- /// @throw DhcpConfigError if the option space requested is not valid
+ /// @throw DhcpConfigError if the option space requested is not valid
/// for this server.
virtual OptionDefinitionPtr findServerSpaceOptionDefinition (
std::string& option_space, uint32_t option_code) = 0;
@@ -435,13 +435,13 @@ private:
/// Option space name where the option belongs to.
std::string option_space_;
- /// Parsing context which contains global values, options and option
+ /// Parsing context which contains global values, options and option
/// definitions.
ParserContextPtr global_context_;
};
///@brief Function pointer for OptionDataParser factory methods
-typedef OptionDataParser *OptionDataParserFactory(const std::string&,
+typedef OptionDataParser *OptionDataParserFactory(const std::string&,
OptionStoragePtr options, ParserContextPtr global_context);
/// @brief Parser for option data values within a subnet.
@@ -454,15 +454,15 @@ class OptionDataListParser : public DhcpConfigParser {
public:
/// @brief Constructor.
///
- /// @param string& nominally would be param name, this is always ignored.
+ /// @param dummy nominally would be param name, this is always ignored.
/// @param options parsed option storage for options in this list
- /// @param global_context is a pointer to the global context which
- /// stores global scope parameters, options, option defintions.
- /// @param optionDataParserFactory factory method for creating individual
- /// option parsers
+ /// @param global_context is a pointer to the global context which
+ /// stores global scope parameters, options, option defintions.
+ /// @param optionDataParserFactory factory method for creating individual
+ /// option parsers
/// @throw isc::dhcp::DhcpConfigError if options or global_context are null.
- OptionDataListParser(const std::string&, OptionStoragePtr options,
- ParserContextPtr global_context,
+ OptionDataListParser(const std::string& dummy, OptionStoragePtr options,
+ ParserContextPtr global_context,
OptionDataParserFactory *optionDataParserFactory);
/// @brief Parses entries that define options' data for a subnet.
@@ -492,7 +492,7 @@ private:
/// Collection of parsers;
ParserCollection parsers_;
- /// Parsing context which contains global values, options and option
+ /// Parsing context which contains global values, options and option
/// definitions.
ParserContextPtr global_context_;
@@ -510,10 +510,10 @@ public:
///
/// @param dummy first argument is ignored, all Parser constructors
/// accept string as first argument.
- /// @param storage is the definition storage in which to store the parsed
- /// definition upon "commit".
+ /// @param storage is the definition storage in which to store the parsed
+ /// definition upon "commit".
/// @throw isc::dhcp::DhcpConfigError if storage is null.
- OptionDefParser(const std::string&, OptionDefStoragePtr storage);
+ OptionDefParser(const std::string& dummy, OptionDefStoragePtr storage);
/// @brief Parses an entry that describes single option definition.
///
@@ -561,10 +561,10 @@ public:
///
/// @param dummy first argument is ignored, all Parser constructors
/// accept string as first argument.
- /// @param storage is the definition storage in which to store the parsed
- /// definitions in this list
+ /// @param storage is the definition storage in which to store the parsed
+ /// definitions in this list
/// @throw isc::dhcp::DhcpConfigError if storage is null.
- OptionDefListParser(const std::string&, OptionDefStoragePtr storage);
+ OptionDefListParser(const std::string& dummy, OptionDefStoragePtr storage);
/// @brief Parse configuration entries.
///
@@ -581,7 +581,7 @@ public:
private:
/// @brief storage for option definitions.
- OptionDefStoragePtr storage_;
+ OptionDefStoragePtr storage_;
};
/// @brief a collection of pools
@@ -602,14 +602,13 @@ class PoolParser : public DhcpConfigParser {
public:
/// @brief constructor.
-
-
+ ///
/// @param dummy first argument is ignored, all Parser constructors
/// accept string as first argument.
- /// @param pools is the storage in which to store the parsed pool
- /// upon "commit".
+ /// @param pools is the storage in which to store the parsed pool
+ /// upon "commit".
/// @throw isc::dhcp::DhcpConfigError if storage is null.
- PoolParser(const std::string&, PoolStoragePtr pools);
+ PoolParser(const std::string& dummy, PoolStoragePtr pools);
/// @brief parses the actual list
///
@@ -629,9 +628,9 @@ protected:
///
/// @param addr is the IP prefix of the pool.
/// @param len is the prefix length.
- /// @param ignored dummy parameter to provide symmetry between
- /// @return returns a PoolPtr to the new Pool object.
- virtual PoolPtr poolMaker(isc::asiolink::IOAddress &addr, uint32_t len,
+ /// @param ptype is the type of pool to create.
+ /// @return returns a PoolPtr to the new Pool object.
+ virtual PoolPtr poolMaker(isc::asiolink::IOAddress &addr, uint32_t len,
int32_t ptype=0) = 0;
/// @brief Creates a Pool object given starting and ending IP addresses.
@@ -640,7 +639,7 @@ protected:
/// @param max is the last IP address in the pool.
/// @param ptype is the type of pool to create (not used by all derivations)
/// @return returns a PoolPtr to the new Pool object.
- virtual PoolPtr poolMaker(isc::asiolink::IOAddress &min,
+ virtual PoolPtr poolMaker(isc::asiolink::IOAddress &min,
isc::asiolink::IOAddress &max, int32_t ptype=0) = 0;
/// @brief pointer to the actual Pools storage
@@ -669,7 +668,7 @@ public:
/// @param subnet pointer to the content of subnet definition
///
/// @throw isc::DhcpConfigError if subnet configuration parsing failed.
- virtual void build(isc::data::ConstElementPtr subnet);
+ virtual void build(isc::data::ConstElementPtr subnet);
/// @brief Adds the created subnet to a server's configuration.
virtual void commit() = 0;
@@ -686,7 +685,7 @@ protected:
const std::string& config_id) = 0;
/// @brief Determines if the given option space name and code describe
- /// a standard option for the server.
+ /// a standard option for the server.
///
/// @param option_space is the name of the option space to consider
/// @param code is the numeric option code to consider
@@ -702,20 +701,20 @@ protected:
uint32_t code) = 0;
/// @brief Issues a server specific warning regarding duplicate subnet
- /// options.
- ///
+ /// options.
+ ///
/// @param code is the numeric option code of the duplicate option
- /// @param addr is the subnet address
+ /// @param addr is the subnet address
/// @todo a means to know the correct logger and perhaps a common
/// message would allow this method to be emitted by the base class.
- virtual void duplicate_option_warning(uint32_t code,
+ virtual void duplicate_option_warning(uint32_t code,
isc::asiolink::IOAddress& addr) = 0;
- /// @brief Instantiates the subnet based on a given IP prefix and prefix
- /// length.
- ///
+ /// @brief Instantiates the subnet based on a given IP prefix and prefix
+ /// length.
+ ///
/// @param addr is the IP prefix of the subnet.
- /// @param len is the prefix length
+ /// @param len is the prefix length
virtual void initSubnet(isc::asiolink::IOAddress addr, uint8_t len) = 0;
/// @brief Returns value for a given parameter (after using inheritance)
@@ -739,7 +738,7 @@ private:
/// @brief Create a new subnet using a data from child parsers.
///
- /// @throw isc::dhcp::DhcpConfigError if subnet configuration parsing
+ /// @throw isc::dhcp::DhcpConfigError if subnet configuration parsing
/// failed.
void createSubnet();
@@ -763,7 +762,7 @@ protected:
/// Pointer to the created subnet object.
isc::dhcp::SubnetPtr subnet_;
- /// Parsing context which contains global values, options and option
+ /// Parsing context which contains global values, options and option
/// definitions.
ParserContextPtr global_context_;
};
diff --git a/src/lib/dhcpsrv/tests/dhcp_parsers_unittest.cc b/src/lib/dhcpsrv/tests/dhcp_parsers_unittest.cc
index b4b9451..cde227a 100644
--- a/src/lib/dhcpsrv/tests/dhcp_parsers_unittest.cc
+++ b/src/lib/dhcpsrv/tests/dhcp_parsers_unittest.cc
@@ -48,7 +48,7 @@ public:
/// @brief Check BooleanParser basic functionality.
-///
+///
/// Verifies that the parser:
/// 1. Does not allow empty for storage.
/// 2. Rejects a non-boolean element.
@@ -95,7 +95,7 @@ TEST_F(DhcpParserTest, booleanParserTest) {
}
/// @brief Check StringParser basic functionality
-///
+///
/// Verifies that the parser:
/// 1. Does not allow empty for storage.
/// 2. Builds with a nont string value.
@@ -135,7 +135,7 @@ TEST_F(DhcpParserTest, stringParserTest) {
}
/// @brief Check Uint32Parser basic functionality
-///
+///
/// Verifies that the parser:
/// 1. Does not allow empty for storage.
/// 2. Rejects a non-integer element.
@@ -164,8 +164,8 @@ TEST_F(DhcpParserTest, uint32ParserTest) {
ElementPtr int_element = Element::create(-1);
EXPECT_THROW(parser.build(int_element), isc::BadValue);
- // Verify that parser with rejects too large a value provided we are on
- // 64-bit platform.
+ // Verify that parser with rejects too large a value provided we are on
+ // 64-bit platform.
if (sizeof(long) > sizeof(uint32_t)) {
long max = (long)(std::numeric_limits<uint32_t>::max()) + 1;
int_element->setValue(max);
@@ -246,13 +246,13 @@ TEST_F(DhcpParserTest, interfaceListParserTest) {
EXPECT_TRUE(cfg_mgr.isActiveIface("eth2"));
}
-/// @brief Test Implementation of abstract OptionDataParser class. Allows
+/// @brief Test Implementation of abstract OptionDataParser class. Allows
/// testing basic option parsing.
class UtestOptionDataParser : public OptionDataParser {
public:
- UtestOptionDataParser(const std::string&,
- OptionStoragePtr options, ParserContextPtr global_context)
+ UtestOptionDataParser(const std::string&,
+ OptionStoragePtr options, ParserContextPtr global_context)
:OptionDataParser("", options, global_context) {
}
@@ -266,12 +266,12 @@ protected:
virtual OptionDefinitionPtr findServerSpaceOptionDefinition (
std::string&, uint32_t) {
OptionDefinitionPtr def;
- // always return empty
+ // always return empty
return (def);
}
};
-/// @brief Test Fixture class which provides basic structure for testing
+/// @brief Test Fixture class which provides basic structure for testing
/// configuration parsing. This is essentially the same structure provided
/// by dhcp servers.
class ParseConfigTest : public ::testing::Test {
@@ -285,15 +285,15 @@ public:
reset_context();
}
- /// @brief Parses a configuration.
+ /// @brief Parses a configuration.
///
/// Parse the given configuration, populating the context storage with
- /// the parsed elements.
- ///
+ /// the parsed elements.
+ ///
/// @param config_set is the set of elements to parse.
/// @return returns an ConstElementPtr containing the numeric result
/// code and outcome comment.
- isc::data::ConstElementPtr parseElementSet(isc::data::ConstElementPtr
+ isc::data::ConstElementPtr parseElementSet(isc::data::ConstElementPtr
config_set) {
// Answer will hold the result.
ConstElementPtr answer;
@@ -325,7 +325,7 @@ public:
}
// The option values parser is the next one to be run.
- std::map<std::string, ConstElementPtr>::const_iterator
+ std::map<std::string, ConstElementPtr>::const_iterator
option_config = values_map.find("option-data");
if (option_config != values_map.end()) {
option_parser->build(option_config->second);
@@ -348,21 +348,21 @@ public:
/// @brief Create an element parser based on the element name.
///
- /// Note that currently it only supports option-defs and option-data,
- ///
- /// @param config_id is the name of the configuration element.
+ /// Note that currently it only supports option-defs and option-data,
+ ///
+ /// @param config_id is the name of the configuration element.
/// @return returns a raw pointer to DhcpConfigParser. Note caller is
/// responsible for deleting it once no longer needed.
/// @throw throws NotImplemented if element name isn't supported.
DhcpConfigParser* createConfigParser(const std::string& config_id) {
DhcpConfigParser* parser = NULL;
if (config_id.compare("option-data") == 0) {
- parser = new OptionDataListParser(config_id,
- parser_context_->options_,
+ parser = new OptionDataListParser(config_id,
+ parser_context_->options_,
parser_context_,
UtestOptionDataParser::factory);
} else if (config_id.compare("option-def") == 0) {
- parser = new OptionDefListParser(config_id,
+ parser = new OptionDefListParser(config_id,
parser_context_->option_defs_);
} else {
isc_throw(NotImplemented,
@@ -373,15 +373,15 @@ public:
return (parser);
}
- /// @brief Convenicee method for parsing a configuration
- ///
+ /// @brief Convenicee method for parsing a configuration
+ ///
/// Given a configuration string, convert it into Elements
- /// and parse them.
+ /// and parse them.
/// @param config is the configuration string to parse
///
- /// @return retuns 0 if the configuration parsed successfully,
+ /// @return retuns 0 if the configuration parsed successfully,
/// non-zero otherwise failure.
- int parseConfiguration (std::string &config) {
+ int parseConfiguration (std::string &config) {
int rcode_ = 1;
// Turn config into elements.
// Test json just to make sure its valid.
@@ -395,17 +395,17 @@ public:
return (rcode_);
}
- /// @brief Find an option definition for a given space and code within
+ /// @brief Find an option definition for a given space and code within
/// the parser context.
/// @param space is the space name of the desired option.
/// @param code is the numeric "type" of the desired option.
/// @return returns an OptionDefinitionPtr which points to the found
/// definition or is empty.
- /// ASSERT_ tests don't work inside functions that return values
+ /// ASSERT_ tests don't work inside functions that return values
OptionDefinitionPtr getOptionDef(std::string space, uint32_t code)
{
OptionDefinitionPtr def;
- OptionDefContainerPtr defs =
+ OptionDefContainerPtr defs =
parser_context_->option_defs_->getItems(space);
// Should always be able to get definitions list even if it is empty.
EXPECT_TRUE(defs);
@@ -419,41 +419,41 @@ public:
def = *(idx.begin());
}
}
- return (def);
+ return (def);
}
- /// @brief Find an option for a given space and code within the parser
+ /// @brief Find an option for a given space and code within the parser
/// context.
/// @param space is the space name of the desired option.
/// @param code is the numeric "type" of the desired option.
/// @return returns an OptionPtr which points to the found
/// option or is empty.
- /// ASSERT_ tests don't work inside functions that return values
+ /// ASSERT_ tests don't work inside functions that return values
OptionPtr getOptionPtr(std::string space, uint32_t code)
{
OptionPtr option_ptr;
- Subnet::OptionContainerPtr options =
+ Subnet::OptionContainerPtr options =
parser_context_->options_->getItems(space);
// Should always be able to get options list even if it is empty.
EXPECT_TRUE(options);
if (options) {
// Attempt to find desired option.
const Subnet::OptionContainerTypeIndex& idx = options->get<1>();
- const Subnet::OptionContainerTypeRange& range =
+ const Subnet::OptionContainerTypeRange& range =
idx.equal_range(code);
int cnt = std::distance(range.first, range.second);
EXPECT_EQ(1, cnt);
if (cnt == 1) {
- Subnet::OptionDescriptor desc = *(idx.begin());
- option_ptr = desc.option;
+ Subnet::OptionDescriptor desc = *(idx.begin());
+ option_ptr = desc.option;
EXPECT_TRUE(option_ptr);
}
}
- return (option_ptr);
+ return (option_ptr);
}
- /// @brief Wipes the contents of the context to allowing another parsing
+ /// @brief Wipes the contents of the context to allowing another parsing
/// during a given test if needed.
void reset_context(){
// Note set context universe to V6 as it has to be something.
@@ -468,7 +468,7 @@ public:
};
/// @brief Check Basic parsing of option definitions.
-///
+///
/// Note that this tests basic operation of the OptionDefinitionListParser and
/// OptionDefinitionParser. It uses a simple configuration consisting of one
/// one definition and verifies that it is parsed and committed to storage
@@ -493,7 +493,7 @@ TEST_F(ParseConfigTest, basicOptionDefTest) {
ASSERT_TRUE(rcode == 0);
// Verify that the option definition can be retrieved.
- OptionDefinitionPtr def = getOptionDef("isc", 100);
+ OptionDefinitionPtr def = getOptionDef("isc", 100);
ASSERT_TRUE(def);
// Verify that the option definition is correct.
@@ -505,7 +505,7 @@ TEST_F(ParseConfigTest, basicOptionDefTest) {
}
/// @brief Check Basic parsing of options.
-///
+///
/// Note that this tests basic operation of the OptionDataListParser and
/// OptionDataParser. It uses a simple configuration consisting of one
/// one definition and matching option data. It verifies that the option
More information about the bind10-changes
mailing list