Kea 2.5.7
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.
 
- 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.
 
uint32_t getUint32 (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a value converted to uint32_t.
 
uint8_t getUint8 (ConstElementPtr scope, const std::string &name)
 Get an uint8_t value.
 
const isc::util::Triplet< uint32_t > parseIntTriplet (const data::ConstElementPtr &scope, const std::string &name)
 Parses an integer triplet.
 

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.
 
static void checkRequired (const SimpleRequiredKeywords &required, isc::data::ConstElementPtr scope)
 Checks that all required keywords are present.
 
static size_t deriveParams (isc::data::ConstElementPtr parent, isc::data::ElementPtr child, const ParamsList &params)
 Derives (inherits) parameters from parent scope to a child.
 
static isc::asiolink::IOAddress getAddress (const ConstElementPtr &scope, const std::string &name)
 Returns a IOAddress parameter from a scope.
 
static bool getBoolean (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a boolean parameter from a scope.
 
static double getDouble (const ConstElementPtr &scope, const std::string &name)
 Returns a floating point parameter from a scope.
 
static int64_t getInteger (isc::data::ConstElementPtr scope, const std::string &name)
 Returns an integer parameter from a scope.
 
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.
 
static const data::Element::PositiongetPosition (const std::string &name, const data::ConstElementPtr parent)
 Utility method that returns position of an element.
 
static std::string getString (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a string parameter from a scope.
 
static size_t setDefaults (isc::data::ElementPtr scope, const SimpleDefaults &default_values)
 Sets the default values.
 
static size_t setListDefaults (isc::data::ConstElementPtr list, const SimpleDefaults &default_values)
 Sets the default values for all entries in a list.
 
- 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.
 
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.
 

Detailed Description

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

Parser for a list of host reservations for a subnet.

Template Parameters
HostReservationParserTypeHost reservation parser to be used to parse individual reservations: HostReservationParser4 or HostReservationParser6.

Definition at line 24 of file host_reservations_list_parser.h.

Member Function Documentation

◆ parse()

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_idIdentifier of the subnet to which the reservations belong.
hr_listData element holding a list of host reservations. Each host reservation is described by a map object.
[out]hosts_listHosts representing parsed reservations are stored in this list.
Exceptions
DhcpConfigErrorIf the configuration if any of the reservations is invalid.

Definition at line 38 of file host_reservations_list_parser.h.

Referenced by isc::dhcp::Subnet4ConfigParser::parse(), isc::dhcp::Subnet6ConfigParser::parse(), isc::dhcp::processDhcp4Config(), and isc::dhcp::processDhcp6Config().


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