Overrides the default option data parser. More...

#include <cb_parsers.h>

Inheritance diagram for isc::cb::CBOptionDataParser:

Public Member Functions
	CBOptionDataParser (const uint16_t address_family, dhcp::CfgOptionDefPtr cfg_option_def, db::BackendSelector &backend_selector, db::ServerSelector &server_selector)
	Constructor.
Public Member Functions inherited from isc::dhcp::OptionDataParser
	OptionDataParser (const uint16_t address_family, CfgOptionDefPtr cfg_option_def=CfgOptionDefPtr())
	Constructor.
virtual	~OptionDataParser ()
	Virtual destructor.
std::pair< OptionDescriptor, std::string >	parse (isc::data::ConstElementPtr single_option)
	Parses ElementPtr containing option definition.
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 dhcp::OptionDefinitionPtr	findOptionDefinition (const std::string &option_space, const util::Optional< uint32_t > &option_code, const util::Optional< std::string > &option_name) const
	Finds an option definition within an option space.
Protected Member Functions inherited from isc::dhcp::OptionDataParser
std::pair< OptionDescriptor, std::string >	createOption (isc::data::ConstElementPtr option_data)
	Create option instance.
util::Optional< bool >	extractCancelled (data::ConstElementPtr parent) const
	Retrieves cancelled/never-send parameter as an optional value.
util::Optional< uint32_t >	extractCode (data::ConstElementPtr parent) const
	Retrieves parsed option code as an optional value.
util::Optional< bool >	extractCSVFormat (data::ConstElementPtr parent) const
	Retrieves csv-format parameter as an optional value.
util::Optional< std::string >	extractData (data::ConstElementPtr parent) const
	Retrieves option data as a string.
util::Optional< std::string >	extractName (data::ConstElementPtr parent) const
	Retrieves parsed option name as an optional value.
util::Optional< bool >	extractPersistent (data::ConstElementPtr parent) const
	Retrieves persistent/always-send parameter as an optional value.
std::string	extractSpace (data::ConstElementPtr parent) const
	Retrieves option space name.
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 to be used to fetch option definitions during option data parsing.
db::ServerSelector &	server_selector_
	Server selector to be used to fetch option definitions during option data parsing.
Protected Attributes inherited from isc::dhcp::OptionDataParser
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 parser.

It modifies the findOptionDefinition logic to search for the non-standard option definitions in the configuration backend.

Definition at line 232 of file cb_parsers.h.

Constructor & Destructor Documentation

◆ CBOptionDataParser()

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

Constructor.

Parameters

address_family	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 252 of file cb_parsers.cc.

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

Here is the call graph for this function:

Member Function Documentation

◆ findOptionDefinition()

OptionDefinitionPtr isc::cb::CBOptionDataParser::findOptionDefinition	(	const std::string &	option_space,
		const util::Optional< uint32_t > &	option_code,
		const util::Optional< std::string > &	option_name ) const

protectedvirtual

Finds an option definition within an option space.

Given an option space and an option code or option space, find the corresponding option definition in the configuration backend and among the standard options.

It tries to find an option definition using various sources in the following order:

cfg_option_def_ structure (passed in the constructor),
standard option definitions in libdhcp++,
vendor option definitions in libdhcp++,
configuration backend for the backend and server selector specified in the constructor,
runtime option definitions,
last resort option definitions in libdhcp++.

The function breaks when it finds the first option definition in any of the sources listed above.

The caller must specify an option code or an option name. If neither of them is specified, the function returns a null pointer. If the option code is specified, the option name is ignored. If option code is not specified, the option name is used as a key to find the option definition.

Parameters

option_space	option space name.
option_code	option code to be used to find the option definition.
option_name	option name to be used to find the option definition if an option code is not specified.

Returns: OptionDefinitionPtr of the option definition or an empty OptionDefinitionPtr if not found.

Exceptions

DhcpConfigError if the option space requested is not valid for this server.

Reimplemented from isc::dhcp::OptionDataParser.

Definition at line 262 of file cb_parsers.cc.

References isc::dhcp::OptionDataParser::address_family_, backend_selector_, isc::dhcp::OptionDataParser::cfg_option_def_, isc::dhcp::LibDHCP::getLastResortOptionDef(), isc::dhcp::LibDHCP::getOptionDef(), isc::dhcp::LibDHCP::getRuntimeOptionDef(), isc::dhcp::LibDHCP::getVendorOptionDef(), isc::dhcp::ConfigBackendDHCPv4Mgr::instance(), isc::dhcp::ConfigBackendDHCPv6Mgr::instance(), isc::dhcp::LibDHCP::optionSpaceToVendorId(), server_selector_, isc::util::Optional< T >::unspecified(), isc::dhcp::Option::V4, and isc::dhcp::Option::V6.

Here is the call graph for this function:

Member Data Documentation

◆ backend_selector_

db::BackendSelector& isc::cb::CBOptionDataParser::backend_selector_

protected

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

Definition at line 294 of file cb_parsers.h.

Referenced by CBOptionDataParser(), and findOptionDefinition().

◆ server_selector_

db::ServerSelector& isc::cb::CBOptionDataParser::server_selector_

protected

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

Definition at line 298 of file cb_parsers.h.

Referenced by CBOptionDataParser(), and findOptionDefinition().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members