Kea  2.1.7-git
isc::dhcp::PoolParser Class Referenceabstract

parser for a single pool definition More...

#include <dhcp_parsers.h>

+ Inheritance diagram for isc::dhcp::PoolParser:

Public Member Functions

virtual ~PoolParser ()
 destructor. More...
 
virtual void parse (PoolStoragePtr pools, isc::data::ConstElementPtr pool_structure, const uint16_t address_family)
 parses the actual structure 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< OptionDataListParsercreateOptionDataListParser (const uint16_t address_family) const
 Returns an instance of the OptionDataListParser to be used in parsing the option-data structure. More...
 
virtual PoolPtr poolMaker (isc::asiolink::IOAddress &addr, uint32_t len, int32_t ptype=0)=0
 Creates a Pool object given a IPv4 prefix and the prefix length. More...
 
virtual PoolPtr poolMaker (isc::asiolink::IOAddress &min, isc::asiolink::IOAddress &max, int32_t ptype=0)=0
 Creates a Pool object given starting and ending IP addresses. 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 single pool definition

This abstract parser handles pool definitions, i.e. a list of entries of one of two syntaxes: min-max and prefix/len. Pool objects are created and stored in chosen PoolStorage container.

It is useful for parsing Dhcp<4/6>/subnet<4/6>[X]/pools[X] structure.

Definition at line 290 of file dhcp_parsers.h.

Constructor & Destructor Documentation

◆ ~PoolParser()

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

destructor.

Definition at line 294 of file dhcp_parsers.h.

Member Function Documentation

◆ createOptionDataListParser()

boost::shared_ptr< OptionDataListParser > isc::dhcp::PoolParser::createOptionDataListParser ( const uint16_t  address_family) const
protectedvirtual

Returns an instance of the OptionDataListParser to be used in parsing the option-data structure.

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

Parameters
address_familyAF_INET (for DHCPv4) or AF_INET6 (for DHCPv6).
Returns
an instance of the OptionDataListParser.

Definition at line 505 of file dhcp_parsers.cc.

◆ parse()

void isc::dhcp::PoolParser::parse ( PoolStoragePtr  pools,
isc::data::ConstElementPtr  pool_structure,
const uint16_t  address_family 
)
virtual

parses the actual structure

This method parses the actual list of interfaces. No validation is done at this stage, everything is interpreted as interface name.

Parameters
poolsis the storage in which to store the parsed pool
pool_structurea single entry on a list of pools
address_familyAF_INET (for DHCPv4) or AF_INET6 (for DHCPv6).
Exceptions
isc::dhcp::DhcpConfigErrorwhen pool parsing fails

Definition at line 350 of file dhcp_parsers.cc.

References isc::data::SimpleParser::checkKeywords(), isc_throw, isc::dhcp::SimpleParser4::POOL4_PARAMETERS, isc::dhcp::SimpleParser6::POOL6_PARAMETERS, and isc::Exception::what().

+ Here is the call graph for this function:

◆ poolMaker() [1/2]

virtual PoolPtr isc::dhcp::PoolParser::poolMaker ( isc::asiolink::IOAddress addr,
uint32_t  len,
int32_t  ptype = 0 
)
protectedpure virtual

Creates a Pool object given a IPv4 prefix and the prefix length.

Parameters
addris the IP prefix of the pool.
lenis the prefix length.
ptypeis the type of pool to create.
Returns
returns a PoolPtr to the new Pool object.

Implemented in isc::dhcp::Pool6Parser, and isc::dhcp::Pool4Parser.

◆ poolMaker() [2/2]

virtual PoolPtr isc::dhcp::PoolParser::poolMaker ( isc::asiolink::IOAddress min,
isc::asiolink::IOAddress max,
int32_t  ptype = 0 
)
protectedpure virtual

Creates a Pool object given starting and ending IP addresses.

Parameters
minis the first IP address in the pool.
maxis the last IP address in the pool.
ptypeis the type of pool to create (not used by all derivations)
Returns
returns a PoolPtr to the new Pool object.

Implemented in isc::dhcp::Pool6Parser, and isc::dhcp::Pool4Parser.


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