Kea 3.3.4
isc::cb::CBClientClassDefParser Class Reference

Overrides the default parser for DHCP client classes. More...

#include <cb_parsers.h>

Inheritance diagram for isc::cb::CBClientClassDefParser:

Public Member Functions

 CBClientClassDefParser (db::BackendSelector &backend_selector, db::ServerSelector &server_selector)
 Constructor.
virtual boost::shared_ptr< OptionDataListParser > createOptionDataListParser (const uint16_t address_family, CfgOptionDefPtr cfg_option_def) const
 Returns an instance of the CBOptionDataListParser.
Public Member Functions inherited from isc::dhcp::ClientClassDefParser
virtual ~ClientClassDefParser ()
 Virtual destructor.
void checkParametersSupported (const isc::data::ConstElementPtr &class_def_cfg, const uint16_t family)
 Iterates over class parameters and checks if they are supported.
void parse (ClientClassDictionaryPtr &class_dictionary, isc::data::ConstElementPtr client_class_def, uint16_t family, bool append_error_position=true, bool check_dependencies=true)
 Parses an entry that describes single client class 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 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.

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

Overrides the default parser for DHCP client classes.

This parser uses the CB specific parser for options.

Definition at line 938 of file cb_parsers.h.

Constructor & Destructor Documentation

◆ CBClientClassDefParser()

isc::cb::CBClientClassDefParser::CBClientClassDefParser ( db::BackendSelector & backend_selector,
db::ServerSelector & server_selector )

Constructor.

Parameters
backend_selectorbackend selector used to fetch option definitions during option data parsing.
server_selectorserver selector used to fetch option definitions during option data parsing.

Definition at line 838 of file cb_parsers.cc.

References backend_selector_, and server_selector_.

Member Function Documentation

◆ createOptionDataListParser()

boost::shared_ptr< OptionDataListParser > isc::cb::CBClientClassDefParser::createOptionDataListParser ( const uint16_t address_family,
CfgOptionDefPtr cfg_option_def ) const
virtual

Returns an instance of the CBOptionDataListParser.

Parameters
address_familyAF_INET (for DHCPv4) or AF_INET6 (for DHCPv6).
cfg_option_defstructure holding option definitions.
Returns
an instance of the CBOptionDataListParser.

Reimplemented from isc::dhcp::ClientClassDefParser.

Definition at line 844 of file cb_parsers.cc.

References backend_selector_, and server_selector_.

Member Data Documentation

◆ backend_selector_

db::BackendSelector& isc::cb::CBClientClassDefParser::backend_selector_
protected

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

Definition at line 964 of file cb_parsers.h.

Referenced by CBClientClassDefParser(), and createOptionDataListParser().

◆ server_selector_

db::ServerSelector& isc::cb::CBClientClassDefParser::server_selector_
protected

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

Definition at line 968 of file cb_parsers.h.

Referenced by CBClientClassDefParser(), and createOptionDataListParser().


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