isc::cb::CBClientClassParser Class Reference

Implements a parser for a DHCPv4 or DHCPv6 client class. More...

#include <cb_parsers.h>

Inheritance diagram for isc::cb::CBClientClassParser:

Public Member Functions
	CBClientClassParser (uint16_t family, CfgOptionDefPtr cfg_option_def, db::BackendSelector &backend_selector, db::ServerSelector &server_selector)
	Constructor.
std::pair< dhcp::ClientClassDefPtr, std::string >	parse (data::ConstElementPtr client_class)
	Parses a client class.
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 a DHCPv4 or DHCPv6 client class.

It is a wrapper around the ClientClassDefParser making it possible to use the parser in the parseInputListElement and return the follow_client_class value.

Definition at line 976 of file cb_parsers.h.

Constructor & Destructor Documentation

CBClientClassParser()

isc::cb::CBClientClassParser::CBClientClassParser	(	uint16_t	family,
		CfgOptionDefPtr	cfg_option_def,
		db::BackendSelector &	backend_selector,
		db::ServerSelector &	server_selector )

Constructor.

Parameters

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

Member Function Documentation

parse()

std::pair< ClientClassDefPtr, std::string > isc::cb::CBClientClassParser::parse

(

data::ConstElementPtr

client_class

)

Parses a client class.

Specialization of the ClientClassDefParser returning the optional value of the follow_class_name used to position the client class after another class.

Parameters

client_class

client class to be parsed.

Returns

a pair of parsed client class and the value of the follow_class_name.

Definition at line 862 of file cb_parsers.cc.

References isc::data::SimpleParser::getString(), isc_throw, Element::null, and isc::dhcp::ClientClassDefParser::parse().

Here is the call graph for this function:

---

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

• cb_parsers.h
• cb_parsers.cc