isc::dhcp::OptionDataListParser Class Reference

Parser for option data values within a subnet. More...

#include <option_data_parser.h>

Inheritance diagram for isc::dhcp::OptionDataListParser:

Public Member Functions
	OptionDataListParser (const uint16_t address_family, CfgOptionDefPtr cfg_option_def=CfgOptionDefPtr())
	Constructor. More...
void	parse (const CfgOptionPtr &cfg, isc::data::ConstElementPtr option_data_list)
	Parses a list of options, instantiates them and stores in cfg. 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 option data values within a subnet.

This parser iterates over all entries that define options data for a particular subnet and creates a collection of options. If parsing is successful, all these options are added to the Subnet object.

Definition at line 179 of file option_data_parser.h.

Constructor & Destructor Documentation

isc::dhcp::OptionDataListParser::OptionDataListParser	(	const uint16_t	address_family,
		CfgOptionDefPtr	cfg_option_def = CfgOptionDefPtr()
	)

Constructor.

Parameters

address_family	Address family: AF_INET or AF_INET6
cfg_option_def	Config option definitions (optional)

Definition at line 400 of file option_data_parser.cc.

Member Function Documentation

void isc::dhcp::OptionDataListParser::parse	(	const CfgOptionPtr &	cfg,
		isc::data::ConstElementPtr	option_data_list
	)

Parses a list of options, instantiates them and stores in cfg.

This method expects to get a list of options in option_data_list, iterates over them, creates option objects, wraps them with option descriptor and stores in specified cfg.

Parameters

cfg	created options will be stored here
option_data_list	configuration that describes the options

Definition at line 408 of file option_data_parser.cc.

References isc::dhcp::OptionDataParser::parse().

Referenced by isc::dhcp::configureDhcp4Server(), isc::dhcp::configureDhcp6Server(), isc::dhcp::SharedNetwork4Parser::parse(), isc::dhcp::SharedNetwork6Parser::parse(), isc::dhcp::ClientClassDefParser::parse(), isc::dhcp::PoolParser::parse(), isc::dhcp::SubnetConfigParser::parse(), isc::dhcp::PdPoolParser::parse(), isc::dhcp::HostReservationParser4::parseInternal(), and isc::dhcp::HostReservationParser6::parseInternal().

Here is the call graph for this function:

---

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

• option_data_parser.h
• option_data_parser.cc