Kea  2.1.7-git
isc::dhcp::SubnetConfigParser Class Referenceabstract

this class parses a single subnet More...

#include <dhcp_parsers.h>

+ Inheritance diagram for isc::dhcp::SubnetConfigParser:

Public Member Functions

 SubnetConfigParser (uint16_t family, bool check_iface=true)
 constructor More...
 
virtual ~SubnetConfigParser ()
 virtual destructor (does nothing) 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 isc::util::Triplet< uint32_t > parseIntTriplet (const data::ConstElementPtr &scope, const std::string &name)
 Parses an integer triplet. More...
 

Protected Member Functions

virtual boost::shared_ptr< OptionDataListParsercreateOptionDataListParser () const
 Returns an instance of the OptionDataListParser to be used in parsing the option-data structure. More...
 
virtual boost::shared_ptr< PoolsListParsercreatePoolsListParser () const =0
 Returns an instance of the PoolsListParser to be used in parsing the address pools. More...
 
void createSubnet (isc::data::ConstElementPtr data)
 Create a new subnet using a data from child parsers. More...
 
virtual void initSubnet (isc::data::ConstElementPtr params, isc::asiolink::IOAddress addr, uint8_t len)=0
 Instantiates the subnet based on a given IP prefix and prefix length. More...
 
SubnetPtr parse (isc::data::ConstElementPtr subnet)
 parses a subnet description and returns Subnet{4,6} structure More...
 
- Protected Member Functions inherited from isc::dhcp::BaseNetworkParser
void parseCacheParams (const data::ConstElementPtr &network_data, NetworkPtr &network)
 Parses parameters related to lease cache settings. More...
 
void parseCommon (const data::ConstElementPtr &network_data, NetworkPtr &network)
 Parses common parameters. More...
 
void parseDdnsParams (const data::ConstElementPtr &network_data, NetworkPtr &network)
 Parses parameters pertaining to DDNS behavior. More...
 
void parseTeePercents (const data::ConstElementPtr &network_data, NetworkPtr &network)
 Parses parameters related to "percent" timers settings. 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...
 

Protected Attributes

uint16_t address_family_
 Address family: AF_INET or AF_INET6. More...
 
bool check_iface_
 Check if the specified interface exists in the system. More...
 
CfgOptionPtr options_
 Pointer to the options configuration. More...
 
PoolStoragePtr pools_
 Storage for pools belonging to this subnet. More...
 
isc::dhcp::Network::RelayInfoPtr relay_info_
 Pointer to relay information. More...
 
isc::dhcp::SubnetPtr subnet_
 Pointer to the created subnet object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from isc::dhcp::BaseNetworkParser
static void moveReservationMode (isc::data::ElementPtr config)
 Moves deprecated reservation-mode parameter to new reservations flags. More...
 
static void moveReservationMode (CfgGlobalsPtr config)
 Moves deprecated reservation-mode parameter to new reservations flags. More...
 
- 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...
 

Detailed Description

this class parses a single subnet

There are dedicated Subnet4ConfigParser and Subnet6ConfigParser classes. They provide specialized parse() methods that return Subnet4Ptr or Subnet6Ptr.

This class parses the whole subnet definition. This class attempts to unify the code between v4 and v6 as much as possible. As a result, the flow is somewhat complex and it looks as follows:

------- Base class

/ | /--— Derived class

  1. * SubnetXConfigParser::parse() is called.
  2. * SubnetConfigParser::parse() is called.
  3. * SubnetConfigParser::createSubnet() is called.
  4. * SubnetXConfigParser::initSubnet() is called (Subnet4 or Subnet6 is instantiated here and family specific parameters are set)
  5. Control returns to createSubnet() (step 3) and common parameters are set.

Definition at line 503 of file dhcp_parsers.h.

Constructor & Destructor Documentation

◆ SubnetConfigParser()

isc::dhcp::SubnetConfigParser::SubnetConfigParser ( uint16_t  family,
bool  check_iface = true 
)
explicit

constructor

Parameters
familyaddress family: AF_INET or AF_INET6
check_ifaceCheck if the specified interface exists in the system.

Definition at line 540 of file dhcp_parsers.cc.

References relay_info_.

◆ ~SubnetConfigParser()

virtual isc::dhcp::SubnetConfigParser::~SubnetConfigParser ( )
inlinevirtual

virtual destructor (does nothing)

Definition at line 514 of file dhcp_parsers.h.

Member Function Documentation

◆ createOptionDataListParser()

boost::shared_ptr< OptionDataListParser > isc::dhcp::SubnetConfigParser::createOptionDataListParser ( ) const
protectedvirtual

Returns an instance of the OptionDataListParser to be used in parsing the option-data structure.

This function can be overridden in the child classes to supply a custom parser for option data.

Returns
an instance of the OptionDataListParser.

Definition at line 663 of file dhcp_parsers.cc.

References address_family_.

Referenced by parse().

◆ createPoolsListParser()

virtual boost::shared_ptr<PoolsListParser> isc::dhcp::SubnetConfigParser::createPoolsListParser ( ) const
protectedpure virtual

Returns an instance of the PoolsListParser to be used in parsing the address pools.

This function can be overridden in the child classes to supply a custom parser for the pools.

Returns
an instance of the PoolsListParser.

Implemented in isc::dhcp::Subnet6ConfigParser, and isc::dhcp::Subnet4ConfigParser.

◆ createSubnet()

void isc::dhcp::SubnetConfigParser::createSubnet ( isc::data::ConstElementPtr  data)
protected

Create a new subnet using a data from child parsers.

Parameters
dataElement map that describes the subnet
Exceptions
isc::dhcp::DhcpConfigErrorif subnet configuration parsing failed.

Definition at line 576 of file dhcp_parsers.cc.

References isc::data::SimpleParser::getString(), initSubnet(), isc::dhcp::CfgMgr::instance(), isc_throw, pools_, subnet_, and isc::Exception::what().

Referenced by parse().

+ Here is the call graph for this function:

◆ initSubnet()

virtual void isc::dhcp::SubnetConfigParser::initSubnet ( isc::data::ConstElementPtr  params,
isc::asiolink::IOAddress  addr,
uint8_t  len 
)
protectedpure virtual

Instantiates the subnet based on a given IP prefix and prefix length.

Parameters
paramsconfiguration parameters for that subnet
addris the IP prefix of the subnet.
lenis the prefix length

Implemented in isc::dhcp::Subnet6ConfigParser, and isc::dhcp::Subnet4ConfigParser.

Referenced by createSubnet().

◆ parse()

SubnetPtr isc::dhcp::SubnetConfigParser::parse ( isc::data::ConstElementPtr  subnet)
protected

parses a subnet description and returns Subnet{4,6} structure

This method is called from specialized (Subnet4ConfigParser or Subnet6ConfigParser) classes.

Parameters
subnetpointer to the content of subnet definition
Returns
a pointer to newly created subnet
Exceptions
isc::DhcpConfigErrorif subnet configuration parsing failed.

Definition at line 549 of file dhcp_parsers.cc.

References address_family_, createOptionDataListParser(), createSubnet(), isc_throw, options_, isc::dhcp::RelayInfoParser::parse(), relay_info_, subnet_, isc::dhcp::Option::V4, isc::dhcp::Option::V6, and isc::Exception::what().

Referenced by isc::dhcp::Subnet4ConfigParser::parse(), and isc::dhcp::Subnet6ConfigParser::parse().

+ Here is the call graph for this function:

Member Data Documentation

◆ address_family_

uint16_t isc::dhcp::SubnetConfigParser::address_family_
protected

Address family: AF_INET or AF_INET6.

Definition at line 572 of file dhcp_parsers.h.

Referenced by createOptionDataListParser(), and parse().

◆ check_iface_

bool isc::dhcp::SubnetConfigParser::check_iface_
protected

Check if the specified interface exists in the system.

Definition at line 581 of file dhcp_parsers.h.

Referenced by isc::dhcp::Subnet4ConfigParser::initSubnet(), and isc::dhcp::Subnet6ConfigParser::initSubnet().

◆ options_

CfgOptionPtr isc::dhcp::SubnetConfigParser::options_
protected

Pointer to the options configuration.

Definition at line 578 of file dhcp_parsers.h.

Referenced by isc::dhcp::Subnet4ConfigParser::initSubnet(), isc::dhcp::Subnet6ConfigParser::initSubnet(), and parse().

◆ pools_

PoolStoragePtr isc::dhcp::SubnetConfigParser::pools_
protected

Storage for pools belonging to this subnet.

Definition at line 566 of file dhcp_parsers.h.

Referenced by createSubnet(), isc::dhcp::Subnet4ConfigParser::parse(), and isc::dhcp::Subnet6ConfigParser::parse().

◆ relay_info_

isc::dhcp::Network::RelayInfoPtr isc::dhcp::SubnetConfigParser::relay_info_
protected

Pointer to relay information.

Definition at line 575 of file dhcp_parsers.h.

Referenced by parse(), isc::dhcp::Subnet4ConfigParser::parse(), isc::dhcp::Subnet6ConfigParser::parse(), and SubnetConfigParser().

◆ subnet_


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