Kea: isc::dhcp::Subnet6ConfigParser Class Reference

| Kea 1.5.0

Public Member Functions | Protected Member Functions | List of all members
isc::dhcp::Subnet6ConfigParser Class Reference

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

`#include <dhcp_parsers.h>`

Inheritance diagram for isc::dhcp::Subnet6ConfigParser:
[legend]

## Public Member Functions
| Subnet6ConfigParser ()
| Constructor. More...
Subnet6Ptr | parse (data::ConstElementPtr subnet)
| Parses a single IPv6 subnet configuration and adds to the Configuration Manager. More...
Public Member Functions inherited from isc::dhcp::SubnetConfigParser
| SubnetConfigParser (uint16_t family)
| 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...

## Protected Member Functions
virtual void | duplicate_option_warning (uint32_t code, asiolink::IOAddress &addr)
| Issues a DHCP6 server specific warning regarding duplicate subnet options. More...
void | initSubnet (isc::data::ConstElementPtr params, isc::asiolink::IOAddress addr, uint8_t len)
| Instantiates the IPv6 Subnet based on a given IPv6 address and prefix length. More...
Protected Member Functions inherited from isc::dhcp::SubnetConfigParser
SubnetPtr | parse (isc::data::ConstElementPtr subnet)
| parses a subnet description and returns Subnet{4,6} structure 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::data::SimpleParser
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 int64_t | getInteger (isc::data::ConstElementPtr scope, const std::string &name)
| Returns an integer parameter from a scope. More...
static const data::Element::Position & | getPosition (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...
Static Protected Member Functions inherited from isc::dhcp::SubnetConfigParser
static Network::HRMode | hrModeFromText (const std::string &txt)
| Attempts to convert text representation to HRMode enum. More...
Protected Attributes inherited from isc::dhcp::SubnetConfigParser
uint16_t | address_family_
| Address family: `AF_INET` or `AF_INET6`. 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 IPv6 subnet.

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

Definition at line 712 of file dhcp_parsers.h.

## Constructor & Destructor Documentation

## ◆ Subnet6ConfigParser()

isc::dhcp::Subnet6ConfigParser::Subnet6ConfigParser | ( |  | ) |

Constructor.

stores global scope parameters, options, option definitions.

Definition at line 1042 of file dhcp_parsers.cc.

## Member Function Documentation

## ◆ duplicate_option_warning()

void isc::dhcp::Subnet6ConfigParser::duplicate_option_warning | ( | uint32_t | code,
|  | asiolink::IOAddress & | addr
| ) |  |
| protectedvirtual

Issues a DHCP6 server specific warning regarding duplicate subnet options.

Parameters

  code | is the numeric option code of the duplicate option
  addr | is the subnet address

Todo:
  A means to know the correct logger and perhaps a common message would allow this message to be emitted by the base class.

Definition at line 1097 of file dhcp_parsers.cc.

References isc::dhcp::dhcpsrv_logger, LOG_WARN, and isc::asiolink::IOAddress::toText().

Here is the call graph for this function:

## ◆ initSubnet()

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

Instantiates the IPv6 Subnet based on a given IPv6 address and prefix length.

Parameters

  params | Data structure describing a subnet.
  addr | is IPv6 prefix of the subnet.
  len | is the prefix length

client-class processing is now generic and handled in the common code (see isc::data::SubnetConfigParser::createSubnet)

Implements isc::dhcp::SubnetConfigParser.

Definition at line 1104 of file dhcp_parsers.cc.

References isc::dhcp::Network::allowClientClass(), D6O_INTERFACE_ID, isc::dhcp::dhcpsrv_logger, isc::data::SimpleParser::getBoolean(), isc::dhcp::Network::getCfgOption(), isc::data::SimpleParser::getInteger(), isc::data::SimpleParser::getPosition(), isc::data::SimpleParser::getString(), isc::dhcp::SubnetConfigParser::hrModeFromText(), isc::dhcp::IfaceMgr::instance(), isc_throw, LOG_INFO, isc::dhcp::SubnetConfigParser::options_, isc::dhcp::Network::requireClientClass(), isc::dhcp::Network::setHostReservationMode(), isc::dhcp::Network::setIface(), isc::dhcp::Network6::setInterfaceId(), isc::dhcp::Network6::setRapidCommit(), isc::dhcp::SubnetConfigParser::subnet_, isc::dhcp::Subnet::toText(), isc::dhcp::Option::V6, and isc::Exception::what().

Here is the call graph for this function:

## ◆ parse()

Subnet6Ptr isc::dhcp::Subnet6ConfigParser::parse | ( | data::ConstElementPtr | subnet | ) |

Parses a single IPv6 subnet configuration and adds to the Configuration Manager.

Parameters

  subnet | A new subnet being configured.

Returns
  a pointer to created Subnet6 object

Parse all pools first.

Definition at line 1047 of file dhcp_parsers.cc.

References isc::dhcp::CfgMgr::getStagingCfg(), isc::dhcp::CfgMgr::instance(), isc_throw, isc::dhcp::HostReservationsListParser< HostReservationParserType >::parse(), isc::dhcp::SubnetConfigParser::parse(), isc::dhcp::Pools6ListParser::parse(), isc::dhcp::PdPoolsListParser::parse(), isc::dhcp::SubnetConfigParser::pools_, isc::dhcp::SubnetConfigParser::relay_info_, and isc::dhcp::SubnetConfigParser::subnet_.

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

Here is the call graph for this function:

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

- dhcp_parsers.h
- dhcp_parsers.cc