Kea  2.1.7-git
isc::dhcp::Subnet4ConfigParser Class Reference

This class parses a single IPv4 subnet. More...

#include <dhcp_parsers.h>

+ Inheritance diagram for isc::dhcp::Subnet4ConfigParser:

Public Member Functions

 Subnet4ConfigParser (bool check_iface=true)
 Constructor. More...
 
Subnet4Ptr parse (data::ConstElementPtr subnet)
 Parses a single IPv4 subnet configuration and adds to the Configuration Manager. More...
 
- Public Member Functions inherited from isc::dhcp::SubnetConfigParser
 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< PoolsListParsercreatePoolsListParser () const
 Returns an instance of the Pools4ListParser to be used in parsing the address pools. More...
 
void initSubnet (data::ConstElementPtr params, asiolink::IOAddress addr, uint8_t len)
 Instantiates the IPv4 Subnet based on a given IPv4 address and prefix length. More...
 
void validateResv (const Subnet4Ptr &subnet, ConstHostPtr host)
 Verifies the host reservation address is in the subnet range. More...
 
- Protected Member Functions inherited from isc::dhcp::SubnetConfigParser
virtual boost::shared_ptr< OptionDataListParsercreateOptionDataListParser () const
 Returns an instance of the OptionDataListParser to be used in parsing the option-data structure. More...
 
void createSubnet (isc::data::ConstElementPtr data)
 Create a new subnet using a data from child parsers. 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...
 

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...
 
- Protected Attributes inherited from isc::dhcp::SubnetConfigParser
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...
 

Detailed Description

This class parses a single IPv4 subnet.

This is the IPv4 derivation of the SubnetConfigParser class and it parses the whole subnet definition. It creates parsersfor received configuration parameters as needed.

Definition at line 590 of file dhcp_parsers.h.

Constructor & Destructor Documentation

◆ Subnet4ConfigParser()

isc::dhcp::Subnet4ConfigParser::Subnet4ConfigParser ( bool  check_iface = true)

Constructor.

stores global scope parameters, options, option definitions.

Parameters
check_ifaceCheck if the specified interface exists in the system.

Definition at line 670 of file dhcp_parsers.cc.

Member Function Documentation

◆ createPoolsListParser()

boost::shared_ptr< PoolsListParser > isc::dhcp::Subnet4ConfigParser::createPoolsListParser ( ) const
protectedvirtual

Returns an instance of the Pools4ListParser 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 Pools4ListParser.

Implements isc::dhcp::SubnetConfigParser.

Definition at line 957 of file dhcp_parsers.cc.

Referenced by parse().

◆ initSubnet()

void isc::dhcp::Subnet4ConfigParser::initSubnet ( data::ConstElementPtr  params,
asiolink::IOAddress  addr,
uint8_t  len 
)
protectedvirtual

◆ parse()

Subnet4Ptr isc::dhcp::Subnet4ConfigParser::parse ( data::ConstElementPtr  subnet)

◆ validateResv()

void isc::dhcp::Subnet4ConfigParser::validateResv ( const Subnet4Ptr subnet,
ConstHostPtr  host 
)
protected

Verifies the host reservation address is in the subnet range.

Parameters
subnetpointer to the subnet
hostpointer to the host reservation
Exceptions
DhcpConfigErrorwhen the address is not in the subnet range.

Definition at line 947 of file dhcp_parsers.cc.

References isc_throw, isc::asiolink::IOAddress::isV4Zero(), and isc::asiolink::IOAddress::toText().

Referenced by parse().

+ Here is the call graph for this function:

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