isc::dhcp::PdPoolParser Class Reference

Parser for IPv6 prefix delegation definitions. More...

#include <dhcp_parsers.h>

Inheritance diagram for isc::dhcp::PdPoolParser:

Public Member Functions
	PdPoolParser ()
	Constructor. More...
void	parse (PoolStoragePtr pools, data::ConstElementPtr pd_pool_)
	Builds a prefix delegation pool from the given configuration. 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

Parser for IPv6 prefix delegation definitions.

This class handles prefix delegation pool definitions for IPv6 subnets Pool6 objects are created and stored in the given PoolStorage container.

PdPool definitions currently support three elements: prefix, prefix-len, and delegated-len, as shown in the example JSON text below:

{
    "prefix": "2001:db8:1::",
    "prefix-len": 64,
    "delegated-len": 128
}

Definition at line 676 of file dhcp_parsers.h.

Constructor & Destructor Documentation

isc::dhcp::PdPoolParser::PdPoolParser

(

)

Constructor.

Definition at line 1049 of file dhcp_parsers.cc.

Member Function Documentation

void isc::dhcp::PdPoolParser::parse	(	PoolStoragePtr	pools,
		data::ConstElementPtr	pd_pool_
	)

Builds a prefix delegation pool from the given configuration.

This function parses configuration entries and creates an instance of a dhcp::Pool6 configured for prefix delegation.

Parameters

pools	storage container in which to store the parsed pool.
pd_pool_	pointer to an element that holds configuration entries that define a prefix delegation pool.

Exceptions

DhcpConfigError

if configuration parsing fails.

Definition at line 1053 of file dhcp_parsers.cc.

References isc::data::SimpleParser::checkKeywords(), isc::data::SimpleParser::getString(), isc::data::SimpleParser::getUint8(), isc_throw, isc::dhcp::OptionDataListParser::parse(), isc::dhcp::SimpleParser6::PD_POOL6_PARAMETERS, and isc::Exception::what().

Referenced by isc::dhcp::PdPoolsListParser::parse().

Here is the call graph for this function:

---

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

• dhcp_parsers.h
• dhcp_parsers.cc