Kea  1.9.9-git
isc::dhcp::OptionDataParser Class Reference

Parser for option data value. More...

#include <option_data_parser.h>

+ Inheritance diagram for isc::dhcp::OptionDataParser:

Public Member Functions

 OptionDataParser (const uint16_t address_family, CfgOptionDefPtr cfg_option_def=CfgOptionDefPtr())
 Constructor. More...
std::pair< OptionDescriptor, std::string > parse (isc::data::ConstElementPtr single_option)
 Parses ElementPtr containing option definition. More...
- 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. More...
uint32_t getUint32 (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a value converted to uint32_t. More...
uint8_t getUint8 (ConstElementPtr scope, const std::string &name)
 Get an uint8_t value. More...
const dhcp::Triplet< uint32_t > parseIntTriplet (const data::ConstElementPtr &scope, const std::string &name)
 Parses an integer triplet. More...

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. More...
static void checkRequired (const SimpleRequiredKeywords &required, isc::data::ConstElementPtr scope)
 Checks that all required keywords are present. More...
static size_t deriveParams (isc::data::ConstElementPtr parent, isc::data::ElementPtr child, const ParamsList &params)
 Derives (inherits) parameters from parent scope to a child. More...
static isc::asiolink::IOAddress getAddress (const ConstElementPtr &scope, const std::string &name)
 Returns a IOAddress parameter from a scope. More...
static bool getBoolean (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a boolean parameter from a scope. More...
static double getDouble (const ConstElementPtr &scope, const std::string &name)
 Returns a floating point parameter from a scope. More...
static int64_t getInteger (isc::data::ConstElementPtr scope, const std::string &name)
 Returns an integer parameter from a scope. More...
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. More...
static const data::Element::PositiongetPosition (const std::string &name, const data::ConstElementPtr parent)
 Utility method that returns position of an element. More...
static std::string getString (isc::data::ConstElementPtr scope, const std::string &name)
 Returns a string parameter from a scope. More...
static size_t setDefaults (isc::data::ElementPtr scope, const SimpleDefaults &default_values)
 Sets the default values. More...
static size_t setListDefaults (isc::data::ConstElementPtr list, const SimpleDefaults &default_values)
 Sets the default values for all entries in a list. More...
- 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. More...
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. More...

Detailed Description

Parser for option data value.

This parser parses configuration entries that specify value of a single option. These entries include option name, option code and data carried by the option. The option data can be specified in one of the two available formats: binary value represented as a string of hexadecimal digits or a list of comma separated values. The format being used is controlled by csv-format configuration parameter. When setting this value to True, the latter format is used. The subsequent values in the CSV format apply to relevant option data fields in the configured option. For example the configuration: "data" : ", 56, hello world" can be used to set values for the option comprising IPv4 address, integer and string data field. Note that order matters. If the order of values does not match the order of data fields within an option the configuration will not be accepted. If parsing is successful then an instance of an option is created and added to the storage provided by the calling class.

Definition at line 41 of file option_data_parser.h.

Constructor & Destructor Documentation

isc::dhcp::OptionDataParser::OptionDataParser ( const uint16_t  address_family,
CfgOptionDefPtr  cfg_option_def = CfgOptionDefPtr() 


address_familyAddress family: AF_INET or AF_INET6.
cfg_option_defConfig option definitions (optional)

Definition at line 32 of file

Member Function Documentation

std::pair< OptionDescriptor, std::string > isc::dhcp::OptionDataParser::parse ( isc::data::ConstElementPtr  single_option)

Parses ElementPtr containing option definition.

This method parses ElementPtr containing the option definition, instantiates the option for it and then returns a pair of option descriptor (that holds that new option) and a string that specifies the option space.

Note: ElementPtr is expected to contain all fields. If your ElementPtr does not have them, please use isc::data::SimpleParser::setDefaults to fill the missing fields with default values.

single_optionElementPtr containing option definition
Option object wrapped in option description and an option space

Definition at line 38 of file

References isc::data::SimpleParser::checkKeywords(), isc_throw, isc::dhcp::SimpleParser4::OPTION4_PARAMETERS, and isc::dhcp::SimpleParser6::OPTION6_PARAMETERS.

Referenced by isc::dhcp::OptionDataListParser::parse().

+ Here is the call graph for this function:

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