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

Parser for the configuration parameters pertaining to the processing of expired leases. More...

#include <expiration_config_parser.h>

+ Inheritance diagram for isc::dhcp::ExpirationConfigParser:

Public Member Functions

virtual ~ExpirationConfigParser ()
 Destructor. More...
 
void parse (isc::data::ConstElementPtr expiration_config)
 Parses parameters in the JSON map, pertaining to the processing of the expired leases. 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...
 

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 the configuration parameters pertaining to the processing of expired leases.

This parser iterates over parameters stored in the map and tries to set the appropriate values in the CfgExpiration object of the Configuration Manager.

Currently supported parameters are:

  • reclaim-timer-wait-time,
  • flush-reclaimed-timer-wait-time,
  • hold-reclaimed-time,
  • max-reclaim-leases,
  • max-reclaim-time,
  • unwarned-reclaim-cycles.

These parameters are optional and the default values are used for those that aren't specified.

The parser checks if the values of the specified parameters are within the allowed ranges and throws exception if they aren't. Each parameter has a corresponding maximum value defined in the CfgExpiration class. None of them may be negative.

Definition at line 39 of file expiration_config_parser.h.

Constructor & Destructor Documentation

◆ ~ExpirationConfigParser()

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

Destructor.

Definition at line 43 of file expiration_config_parser.h.

References parse().

+ Here is the call graph for this function:

Member Function Documentation

◆ parse()

void isc::dhcp::ExpirationConfigParser::parse ( isc::data::ConstElementPtr  expiration_config)

Parses parameters in the JSON map, pertaining to the processing of the expired leases.

Parameters
expiration_configpointer to the content of parsed values
Exceptions
DhcpConfigErrorif unknown parameter specified or the parameter contains invalid value..

Definition at line 22 of file expiration_config_parser.cc.

References isc_throw, and isc::Exception::what().

Referenced by isc::dhcp::configureDhcp4Server(), isc::dhcp::configureDhcp6Server(), and ~ExpirationConfigParser().

+ Here is the call graph for this function:

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