Parser for IPv4 pool definitions. More...

#include <dhcp_parsers.h>

Inheritance diagram for isc::dhcp::Pool4Parser:

Protected Member Functions
PoolPtr	poolMaker (asiolink::IOAddress &addr, uint32_t len, int32_t ignored)
	Creates a Pool4 object given a IPv4 prefix and the prefix length.

PoolPtr	poolMaker (asiolink::IOAddress &min, asiolink::IOAddress &max, int32_t ignored)
	Creates a Pool4 object given starting and ending IPv4 addresses.

Protected Member Functions inherited from isc::dhcp::PoolParser
virtual boost::shared_ptr< OptionDataListParser >	createOptionDataListParser (const uint16_t address_family) const
	Returns an instance of the `OptionDataListParser` to be used in parsing the option-data structure.

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.

Additional Inherited Members
Public Member Functions inherited from isc::dhcp::PoolParser
virtual	~PoolParser ()
	destructor.

virtual void	parse (PoolStoragePtr pools, isc::data::ConstElementPtr pool_structure, const uint16_t address_family, bool encapsulate_options=true)
	parses the actual structure

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.

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::Position &	getPosition (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.

Detailed Description

Parser for IPv4 pool definitions.

This is the IPv4 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 IPv4 pools. Pool4 objects are created and stored in chosen PoolStorage container.

It is useful for parsing Dhcp4/subnet4[X]/pool parameters.

Definition at line 354 of file dhcp_parsers.h.

Member Function Documentation

◆ poolMaker() [1/2]

PoolPtr isc::dhcp::Pool4Parser::poolMaker	(	asiolink::IOAddress &	addr,
		uint32_t	len,
		int32_t	ignored )

protectedvirtual

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

Parameters

addr	is the IPv4 prefix of the pool.
len	is the prefix length.
ignored	dummy parameter to provide symmetry between the PoolParser derivations. The V6 derivation requires a third value.

Returns: returns a PoolPtr to the new Pool4 object.

Implements isc::dhcp::PoolParser.

Definition at line 545 of file dhcp_parsers.cc.

◆ poolMaker() [2/2]

PoolPtr isc::dhcp::Pool4Parser::poolMaker	(	asiolink::IOAddress &	min,
		asiolink::IOAddress &	max,
		int32_t	ignored )

protectedvirtual

Creates a Pool4 object given starting and ending IPv4 addresses.

Parameters

min	is the first IPv4 address in the pool.
max	is the last IPv4 address in the pool.
ignored	dummy parameter to provide symmetry between the PoolParser derivations. The V6 derivation requires a third value.

Returns: returns a PoolPtr to the new Pool4 object.

Implements isc::dhcp::PoolParser.

Definition at line 550 of file dhcp_parsers.cc.

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

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ poolMaker() [1/2]

◆ poolMaker() [2/2]