Overrides the default option data list parser. More...

#include <cb_parsers.h>

Inheritance diagram for isc::cb::CBOptionDataListParser:

Public Member Functions
	CBOptionDataListParser (const uint16_t address_family, CfgOptionDefPtr cfg_option_def, db::BackendSelector &backend_selector, db::ServerSelector &server_selector)
	Constructor.
Public Member Functions inherited from isc::dhcp::OptionDataListParser
	OptionDataListParser (const uint16_t address_family, CfgOptionDefPtr cfg_option_def=CfgOptionDefPtr())
	Constructor.
virtual	~OptionDataListParser ()
	Virtual destructor.
void	parse (const CfgOptionPtr &cfg, isc::data::ConstElementPtr option_data_list, bool encapsulate=true)
	Parses a list of options, instantiates them and stores in cfg.
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.

Protected Member Functions
virtual boost::shared_ptr< OptionDataParser >	createOptionDataParser () const
	Returns an instance of the `CBOptionDataListParser` to be used in parsing options.
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.

Protected Attributes
db::BackendSelector &	backend_selector_
	Backend selector used to fetch option definitions during option data parsing.
db::ServerSelector &	server_selector_
	Server selector used to fetch option definitions during option data parsing.
Protected Attributes inherited from isc::dhcp::OptionDataListParser
uint16_t	address_family_
	Address family: `AF_INET` or `AF_INET6`.
CfgOptionDefPtr	cfg_option_def_
	Config option definitions.

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.
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.
template<typename T>
static void	rangeCheckedInteger (isc::data::ConstElementPtr scope, const std::string &name, T &output_value)
	Fetches a range-checked integer 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

Overrides the default option data list parser.

It modifies the parser to use the CBOptionDataParser for parsing the option data.

Definition at line 305 of file cb_parsers.h.

Constructor & Destructor Documentation

◆ CBOptionDataListParser()

isc::cb::CBOptionDataListParser::CBOptionDataListParser	(	const uint16_t	address_family,
		CfgOptionDefPtr	cfg_option_def,
		db::BackendSelector &	backend_selector,
		db::ServerSelector &	server_selector )

Constructor.

Parameters

address_family	`AF_INET` or `AF_INET6`.
cfg_option_def	container optionally holding option definitions defined for a class.
backend_selector	backend selector used to fetch option definitions during option data parsing.
server_selector	server selector used to fetch option definitions during option data parsing.

Definition at line 356 of file cb_parsers.cc.

References isc::dhcp::OptionDataListParser::OptionDataListParser(), backend_selector_, and server_selector_.

Here is the call graph for this function:

Member Function Documentation

◆ createOptionDataParser()

boost::shared_ptr< OptionDataParser > isc::cb::CBOptionDataListParser::createOptionDataParser ( ) const

protectedvirtual

Returns an instance of the CBOptionDataListParser to be used in parsing options.

Returns: an instance of the CBOptionDataListParser.

Reimplemented from isc::dhcp::OptionDataListParser.

Definition at line 366 of file cb_parsers.cc.

References isc::dhcp::OptionDataListParser::address_family_, backend_selector_, isc::dhcp::OptionDataListParser::cfg_option_def_, and server_selector_.

Member Data Documentation

◆ backend_selector_

db::BackendSelector& isc::cb::CBOptionDataListParser::backend_selector_

protected

Backend selector used to fetch option definitions during option data parsing.

Definition at line 333 of file cb_parsers.h.

Referenced by CBOptionDataListParser(), and createOptionDataParser().

◆ server_selector_

db::ServerSelector& isc::cb::CBOptionDataListParser::server_selector_

protected

Server selector used to fetch option definitions during option data parsing.

Definition at line 337 of file cb_parsers.h.

Referenced by CBOptionDataListParser(), and createOptionDataParser().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members