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

Parser for IPv6 pool definitions. More...

#include <dhcp_parsers.h>

+ Inheritance diagram for isc::dhcp::Pool6Parser:

Protected Member Functions

PoolPtr poolMaker (asiolink::IOAddress &addr, uint32_t len, int32_t ptype)
 Creates a Pool6 object given a IPv6 prefix and the prefix length. More...
 
PoolPtr poolMaker (asiolink::IOAddress &min, asiolink::IOAddress &max, int32_t ptype)
 Creates a Pool6 object given starting and ending IPv6 addresses. More...
 
- Protected Member Functions inherited from isc::dhcp::PoolParser
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...
 
- 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

- Public Member Functions inherited from isc::dhcp::PoolParser
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...
 
- 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 IPv6 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 PoolStorage container.

It is useful for parsing Dhcp6/subnet6[X]/pool parameters.

Definition at line 696 of file dhcp_parsers.h.

Member Function Documentation

◆ poolMaker() [1/2]

PoolPtr isc::dhcp::Pool6Parser::poolMaker ( asiolink::IOAddress addr,
uint32_t  len,
int32_t  ptype 
)
protectedvirtual

Creates a Pool6 object given a IPv6 prefix and the prefix length.

Parameters
addris the IPv6 prefix of the pool.
lenis the prefix length.
ptypeis the type of IPv6 pool (Pool::PoolType). Note this is passed in as an int32_t and cast to PoolType to accommodate a polymorphic interface.
Returns
returns a PoolPtr to the new Pool4 object.

Implements isc::dhcp::PoolParser.

Definition at line 1027 of file dhcp_parsers.cc.

◆ poolMaker() [2/2]

PoolPtr isc::dhcp::Pool6Parser::poolMaker ( asiolink::IOAddress min,
asiolink::IOAddress max,
int32_t  ptype 
)
protectedvirtual

Creates a Pool6 object given starting and ending IPv6 addresses.

Parameters
minis the first IPv6 address in the pool.
maxis the last IPv6 address in the pool.
ptypeis the type of IPv6 pool (Pool::PoolType). Note this is passed in as an int32_t and cast to PoolType to accommodate a polymorphic interface.
Returns
returns a PoolPtr to the new Pool4 object.

Implements isc::dhcp::PoolParser.

Definition at line 1034 of file dhcp_parsers.cc.


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