isc::dhcp::HostReservationsListParser< HostReservationParserType > Class Template Reference

Parser for a list of host reservations for a subnet. More...

#include <host_reservations_list_parser.h>

Inheritance diagram for isc::dhcp::HostReservationsListParser< HostReservationParserType >:

Public Member Functions
void	parse (const SubnetID &subnet_id, isc::data::ConstElementPtr hr_list, HostCollection &hosts_list)
	Parses a list of host reservation entries for a subnet. More...
Public Member Functions inherited from isc::data::SimpleParser
uint16_t	getUint16 (isc::data::ConstElementPtr scope, const std::string &name)
	Returns a value converted to uint16_t. More...
uint32_t	getUint32 (isc::data::ConstElementPtr scope, const std::string &name)
	Returns a value converted to uint32_t. More...
uint8_t	getUint8 (ConstElementPtr scope, const std::string &name)
	Get an uint8_t value. More...
const dhcp::Triplet< uint32_t >	parseIntTriplet (const data::ConstElementPtr &scope, const std::string &name)
	Parses an integer triplet. More...

Additional Inherited Members
Static Public Member Functions inherited from isc::data::SimpleParser
static void	checkKeywords (const SimpleKeywords &keywords, isc::data::ConstElementPtr scope)
	Checks acceptable keywords with their expected type. More...
static void	checkRequired (const SimpleRequiredKeywords &required, isc::data::ConstElementPtr scope)
	Checks that all required keywords are present. More...
static size_t	deriveParams (isc::data::ConstElementPtr parent, isc::data::ElementPtr child, const ParamsList &params)
	Derives (inherits) parameters from parent scope to a child. More...
static isc::asiolink::IOAddress	getAddress (const ConstElementPtr &scope, const std::string &name)
	Returns a IOAddress parameter from a scope. More...
static bool	getBoolean (isc::data::ConstElementPtr scope, const std::string &name)
	Returns a boolean parameter from a scope. More...
static double	getDouble (const ConstElementPtr &scope, const std::string &name)
	Returns a floating point parameter from a scope. More...
static int64_t	getInteger (isc::data::ConstElementPtr scope, const std::string &name)
	Returns an integer parameter from a scope. More...
static int64_t	getInteger (isc::data::ConstElementPtr scope, const std::string &name, int64_t min, int64_t max)
	Returns an integer parameter from a scope and checks its range. More...
static const data::Element::Position &	getPosition (const std::string &name, const data::ConstElementPtr parent)
	Utility method that returns position of an element. More...
static std::string	getString (isc::data::ConstElementPtr scope, const std::string &name)
	Returns a string parameter from a scope. More...
static size_t	setDefaults (isc::data::ElementPtr scope, const SimpleDefaults &default_values)
	Sets the default values. More...
static size_t	setListDefaults (isc::data::ConstElementPtr list, const SimpleDefaults &default_values)
	Sets the default values for all entries in a list. More...
Protected Member Functions inherited from isc::data::SimpleParser
template<typename target_type , target_type convert>
target_type	getAndConvert (isc::data::ConstElementPtr scope, const std::string &name, const std::string &type_name)
	Returns a converted value from a scope. More...
template<typename int_type >
int_type	getIntType (isc::data::ConstElementPtr scope, const std::string &name)
	Returns an integer value with range checking from a scope. More...

Detailed Description

template<typename HostReservationParserType>
class isc::dhcp::HostReservationsListParser< HostReservationParserType >

Parser for a list of host reservations for a subnet.

Template Parameters

HostReservationParserType

Host reservation parser to be used to parse individual reservations: HostReservationParser4 or HostReservationParser6.

Definition at line 25 of file host_reservations_list_parser.h.

Member Function Documentation

template<typename HostReservationParserType>

void isc::dhcp::HostReservationsListParser< HostReservationParserType >::parse ( const SubnetID &  subnet_id, isc::data::ConstElementPtr  hr_list, HostCollection &  hosts_list  )

inline

Parses a list of host reservation entries for a subnet.

Parameters

	subnet_id	Identifier of the subnet to which the reservations belong.
	hr_list	Data element holding a list of host reservations. Each host reservation is described by a map object.
[out]	hosts_list	Hosts representing parsed reservations are stored in this list.

Exceptions

DhcpConfigError

If the configuration if any of the reservations is invalid.

Definition at line 39 of file host_reservations_list_parser.h.

Referenced by isc::dhcp::configureDhcp4Server(), isc::dhcp::configureDhcp6Server(), isc::dhcp::Subnet4ConfigParser::parse(), and isc::dhcp::Subnet6ConfigParser::parse().

---

The documentation for this class was generated from the following file:

• host_reservations_list_parser.h