Kea  2.1.7-git
isc::dhcp::PdPoolsListParser Class Reference

Parser for a list of prefix delegation pools. More...

#include <dhcp_parsers.h>

+ Inheritance diagram for isc::dhcp::PdPoolsListParser:

Public Member Functions

virtual ~PdPoolsListParser ()
 Virtual destructor. More...
 
void parse (PoolStoragePtr pools, data::ConstElementPtr pd_pool_list)
 Parse configuration entries. 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 isc::util::Triplet< uint32_t > parseIntTriplet (const data::ConstElementPtr &scope, const std::string &name)
 Parses an integer triplet. More...
 

Protected Member Functions

virtual boost::shared_ptr< PdPoolParsercreatePdPoolConfigParser () const
 Returns an instance of the PdPoolParser to be used in parsing the prefix delegation pools. 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...
 

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::PositiongetPosition (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...
 

Detailed Description

Parser for a list of prefix delegation pools.

This parser iterates over a list of prefix delegation pool entries and creates pool instances for each one. If the parsing is successful, the collection of pools is committed to the provided storage.

Definition at line 819 of file dhcp_parsers.h.

Constructor & Destructor Documentation

◆ ~PdPoolsListParser()

virtual isc::dhcp::PdPoolsListParser::~PdPoolsListParser ( )
inlinevirtual

Virtual destructor.

Definition at line 823 of file dhcp_parsers.h.

Member Function Documentation

◆ createPdPoolConfigParser()

boost::shared_ptr< PdPoolParser > isc::dhcp::PdPoolsListParser::createPdPoolConfigParser ( ) const
protectedvirtual

Returns an instance of the PdPoolParser to be used in parsing the prefix delegation pools.

This function can be overridden in the child classes to supply a custom parser for the pools.

Returns
an instance of the PdPool6Parser.

Definition at line 1165 of file dhcp_parsers.cc.

◆ parse()

void isc::dhcp::PdPoolsListParser::parse ( PoolStoragePtr  pools,
data::ConstElementPtr  pd_pool_list 
)

Parse configuration entries.

This function parses configuration entries and creates instances of prefix delegation pools .

Parameters
poolsis the pool storage in which to store the parsed
pd_pool_listpointer to an element that holds entries that define a prefix delegation pool.
Exceptions
DhcpConfigErrorif configuration parsing fails.

Definition at line 1156 of file dhcp_parsers.cc.


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