Implements a parser for parsing the option code and space. More...

#include <cb_parsers.h>

Inheritance diagram for isc::cb::CBOptionPairParser:

Public Member Functions
	CBOptionPairParser (const uint16_t address_family)
	Constructor.
virtual	~CBOptionPairParser ()
	Destructor.
std::pair< uint16_t, std::string >	parse (data::ConstElementPtr option, bool skip_keywords=false)
	Parses an option into code + space pair.
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.

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.
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.

Detailed Description

Implements a parser for parsing the option code and space.

Used for getting and deleting an option def or data.

Definition at line 120 of file cb_parsers.h.

Constructor & Destructor Documentation

◆ CBOptionPairParser()

isc::cb::CBOptionPairParser::CBOptionPairParser ( const uint16_t address_family )

inline

Constructor.

Parameters

address_family Address family: AF_INET or AF_INET6.

Definition at line 133 of file cb_parsers.h.

Referenced by isc::cb::CBOptionDefDeleteParser::CBOptionDefDeleteParser(), and isc::cb::CBOptionTupleParser::CBOptionTupleParser().

◆ ~CBOptionPairParser()

virtual isc::cb::CBOptionPairParser::~CBOptionPairParser ( )

inlinevirtual

Destructor.

Definition at line 138 of file cb_parsers.h.

Member Function Documentation

◆ parse()

pair< uint16_t, string > isc::cb::CBOptionPairParser::parse	(	data::ConstElementPtr	option,
		bool	skip_keywords = false )

Parses an option into code + space pair.

The option specification is reduced to the code and space pair. The code is mandatory, the space defaults to the address family standard space. The parser takes, checks and returns them.

Parameters

option	pointer to the content of option definition.
skip_keywords	when true the check for spurious keywords is skipped. Deriving classes may set to avoid spurious keyword errors when invoking this method. Defaults to false.

Returns: the code and space pair.

Exceptions

DhcpConfigError	if the code does not exist, is not an integer
BadValue	if the space exists but is not a valid space name.
OutOfRange	if the code is out of range ([0..255] for DHCPv4, [0..65535] for DHCPv6).

Definition at line 165 of file cb_parsers.cc.

References isc::data::SimpleParser::checkKeywords(), isc::data::SimpleParser::checkRequired(), DHCP4_OPTION_SPACE, DHCP6_OPTION_SPACE, isc::dhcp::DHO_END, isc::dhcp::DHO_PAD, isc::data::SimpleParser::getInteger(), isc_throw, and isc::dhcp::OptionSpace::validateName().

Referenced by isc::cb::CBOptionDefDeleteParser::parse(), and isc::cb::CBOptionTupleParser::parse().

Here is the call graph for this function:

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