Specifies current DHCP configuration. More...

#include <srv_config.h>

Inheritance diagram for isc::dhcp::SrvConfig:

Public Member Functions
	SrvConfig ()
	Default constructor. More...

	SrvConfig (const uint32_t sequence)
	Constructor. More...

void	addConfiguredGlobal (const std::string &name, isc::data::ConstElementPtr value)
	Adds a parameter to the collection configured globals. More...

void	applyDefaultsConfiguredGlobals (const isc::data::SimpleDefaults &defaults)
	Applies defaults to global parameters. More...

void	clearConfiguredGlobals ()
	Removes all configured global parameters. More...

void	configureLowerLevelLibraries () const
	Convenience method to propagate configuration parameters through inversion of control. More...

void	copy (SrvConfig &new_config) const
	Copies the current configuration to a new configuration. More...

void	extractConfiguredGlobals (isc::data::ConstElementPtr config)
	Saves scalar elements from the global scope of a configuration. More...

CfgDbAccessPtr	getCfgDbAccess ()
	Returns pointer to the object holding configuration of the lease and host database connection parameters. More...

ConstCfgDbAccessPtr	getCfgDbAccess () const
	Returns const pointer to the object holding configuration of the lease and host database connection parameters. More...

CfgDUIDPtr	getCfgDUID ()
	Returns pointer to the object holding configuration of the server identifier. More...

ConstCfgDUIDPtr	getCfgDUID () const
	Returns const pointer to the object holding configuration of the server identifier. More...

CfgExpirationPtr	getCfgExpiration ()
	Returns pointer to the object holding configuration pertaining to processing expired leases. More...

ConstCfgExpirationPtr	getCfgExpiration () const
	Returns pointer to the const object holding configuration pertaining to processing expired leases. More...

CfgHostOperationsPtr	getCfgHostOperations4 ()
	Returns pointer to the object holding general configuration for host reservations in DHCPv4. More...

ConstCfgHostOperationsPtr	getCfgHostOperations4 () const
	Returns const pointer to the object holding general configuration for host reservations in DHCPv4. More...

CfgHostOperationsPtr	getCfgHostOperations6 ()
	Returns pointer to the object holding general configuration for host reservations in DHCPv6. More...

ConstCfgHostOperationsPtr	getCfgHostOperations6 () const
	Returns const pointer to the object holding general configuration for host reservations in DHCPv6. More...

CfgHostsPtr	getCfgHosts ()
	Returns pointer to the non-const objects representing host reservations for different IPv4 and IPv6 subnets. More...

ConstCfgHostsPtr	getCfgHosts () const
	Returns pointer to the const objects representing host reservations for different IPv4 and IPv6 subnets. More...

CfgIfacePtr	getCfgIface ()
	Returns non-const pointer to interface configuration. More...

ConstCfgIfacePtr	getCfgIface () const
	Returns const pointer to interface configuration. More...

CfgOptionPtr	getCfgOption ()
	Returns pointer to the non-const object holding options. More...

const ConstCfgOptionPtr	getCfgOption () const
	Returns pointer to the const object holding options. More...

CfgOptionDefPtr	getCfgOptionDef ()
	Return pointer to non-const object representing user-defined option definitions. More...

ConstCfgOptionDefPtr	getCfgOptionDef () const
	Returns pointer to the const object representing user-defined option definitions. More...

CfgRSOOPtr	getCfgRSOO ()
	Returns pointer to the non-const object representing set of RSOO-enabled options. More...

ConstCfgRSOOPtr	getCfgRSOO () const
	Returns pointer to the const object representing set of RSOO-enabled options. More...

CfgSharedNetworks4Ptr	getCfgSharedNetworks4 () const
	Returns pointer to non-const object holding configuration of shared networks in DHCPv4;. More...

CfgSharedNetworks6Ptr	getCfgSharedNetworks6 () const
	Returns pointer to non-const object holding configuration of shared networks in DHCPv6. More...

CfgSubnets4Ptr	getCfgSubnets4 ()
	Returns pointer to non-const object holding subnets configuration for DHCPv4. More...

ConstCfgSubnets4Ptr	getCfgSubnets4 () const
	Returns pointer to const object holding subnets configuration for DHCPv4. More...

CfgSubnets6Ptr	getCfgSubnets6 ()
	Returns pointer to non-const object holding subnets configuration for DHCPv6. More...

ConstCfgSubnets6Ptr	getCfgSubnets6 () const
	Returns pointer to const object holding subnets configuration for DHCPv6. More...

ClientClassDictionaryPtr	getClientClassDictionary ()
	Returns pointer to the dictionary of global client class definitions. More...

const ClientClassDictionaryPtr	getClientClassDictionary () const
	Returns pointer to const dictionary of global client class definitions. More...

std::string	getConfigSummary (const uint32_t selection) const
	Returns summary of the configuration in the textual format. More...

isc::data::ConstElementPtr	getConfiguredGlobal (std::string name) const
	Returns pointer to a given configured global parameter. More...

isc::data::ConstElementPtr	getConfiguredGlobals () const
	Returns pointer to configured global parameters. More...

CfgConsistencyPtr	getConsistency ()
	Returns const pointer to object holding sanity checks flags. More...

const isc::data::ConstElementPtr	getControlSocketInfo () const
	Returns information about control socket. More...

D2ClientConfigPtr	getD2ClientConfig ()
	Returns pointer to the D2 client configuration. More...

const D2ClientConfigPtr	getD2ClientConfig () const
	Returns pointer to const D2 client configuration. More...

DdnsParamsPtr	getDdnsParams (const Subnet4Ptr &subnet) const
	Fetches the DDNS parameters for a given DHCPv4 subnet. More...

DdnsParamsPtr	getDdnsParams (const Subnet6Ptr &subnet) const
	Fetches the DDNS parameters for a given DHCPv6 subnet. More...

uint32_t	getDeclinePeriod () const
	Returns probation-period. More...

uint16_t	getDhcp4o6Port () const
	Returns DHCP4o6 IPC port. More...

const isc::data::ConstElementPtr	getDHCPMultiThreading () const
	Returns DHCP multi threading information. More...

const isc::data::ConstElementPtr	getDHCPQueueControl () const
	Returns DHCP queue control information. More...

bool	getEchoClientId () const
	Returns whether server should send back client-id in DHCPv4. More...

isc::hooks::HooksConfig &	getHooksConfig ()
	Returns non-const reference to configured hooks libraries. More...

const isc::hooks::HooksConfig &	getHooksConfig () const
	Returns const reference to configured hooks libraries. More...

bool	getLenientOptionParsing () const
	Get lenient option parsing compatibility flag. More...

CfgMACSource &	getMACSources ()
	Returns non-const reference to an array that stores MAC/hardware address sources. More...

const CfgMACSource &	getMACSources () const
	Returns const reference to an array that stores MAC/hardware address sources. More...

uint32_t	getSequence () const
	Returns configuration sequence number. More...

virtual void	merge (ConfigBase &other)
	Merges the configuration specified as a parameter into this configuration. More...

void	removeStatistics ()
	Removes statistics. More...

void	sanityChecksLifetime (const std::string &name) const
	Conducts sanity checks on global lifetime parameters. More...

void	sanityChecksLifetime (const SrvConfig &target_config, const std::string &name) const
	Conducts sanity checks on global lifetime parameters before merge from the external configuration to the target one. More...

bool	sequenceEquals (const SrvConfig &other)
	Compares configuration sequence with other sequence. More...

void	setClientClassDictionary (const ClientClassDictionaryPtr &dictionary)
	Sets the client class dictionary. More...

void	setControlSocketInfo (const isc::data::ConstElementPtr &control_socket)
	Sets information about the control socket. More...

void	setD2ClientConfig (const D2ClientConfigPtr &d2_client_config)
	Sets the D2 client configuration. More...

void	setDeclinePeriod (const uint32_t decline_timer)
	Sets decline probation-period. More...

void	setDhcp4o6Port (uint16_t port)
	Sets DHCP4o6 IPC port. More...

void	setDHCPMultiThreading (const isc::data::ConstElementPtr dhcp_multi_threading)
	Sets information about the dhcp multi threading. More...

void	setDHCPQueueControl (const isc::data::ConstElementPtr dhcp_queue_control)
	Sets information about the dhcp queue control. More...

void	setEchoClientId (const bool echo)
	Sets whether server should send back client-id in DHCPv4. More...

void	setIPReservationsUnique (const bool unique)
	Configures the server to allow or disallow specifying multiple hosts with the same IP address/subnet. More...

void	setLenientOptionParsing (bool const value)
	Set lenient option parsing compatibility flag. More...

virtual isc::data::ElementPtr	toElement () const
	Unparse a configuration object. More...

void	updateStatistics ()
	Updates statistics. More...

Methods and operators used to compare configurations.
bool	equals (const SrvConfig &other) const
	Compares two objects for equality. More...

bool	nequals (const SrvConfig &other) const
	Compares two objects for inequality. More...

bool	operator== (const SrvConfig &other) const
	Equality operator. More...

bool	operator!= (const SrvConfig &other) const
	other An object to be compared with this object. More...

Public Member Functions inherited from isc::process::ConfigBase
const process::LoggingInfoStorage &	getLoggingInfo () const
	Returns logging specific configuration. More...

void	addLoggingInfo (const process::LoggingInfo &logging_info)
	Sets logging specific configuration. More...

void	applyLoggingCfg () const
	Apply logging configuration to log4cplus. More...

bool	equals (const ConfigBase &other) const
	Compares two configuration. More...

virtual void	merge (ConfigBase &other)
	Merges specified configuration into this configuration. More...

process::ConstConfigControlInfoPtr	getConfigControlInfo () const
	Fetches a read-only copy of the configuration control information. More...

void	setConfigControlInfo (const process::ConfigControlInfoPtr &config_ctl_info)
	Set the configuration control information. More...

void	setServerTag (const util::Optional< std::string > &server_tag)
	Sets the server's logical name. More...

util::Optional< std::string >	getServerTag () const
	Returns the server's logical name. More...

boost::posix_time::ptime	getLastCommitTime () const
	Returns the last commit timestamp. More...

void	setLastCommitTime (const boost::posix_time::ptime &last_commit_time)
	Sets the last commit timestamp. More...

Public Member Functions inherited from isc::data::UserContext
void	contextToElement (data::ElementPtr map) const
	Merge unparse a user_context object. More...

data::ConstElementPtr	getContext () const
	Returns const pointer to the user context. More...

void	setContext (const data::ConstElementPtr &ctx)
	Sets user context. More...

Public Member Functions inherited from isc::data::CfgToElement
virtual	~CfgToElement ()
	Destructor. More...

Static Public Member Functions
static void	moveDdnsParams (isc::data::ElementPtr srv_elem)
	Moves deprecated parameters from dhcp-ddns element to global element. More...

Static Public Member Functions inherited from isc::data::UserContext
static data::ElementPtr	toElement (data::ConstElementPtr map)
	Copy an Element map. More...

Static Public Attributes
Constants for selection of parameters returned by @c getConfigSummary
static const uint32_t	CFGSEL_NONE = 0x00000000
	Nothing selected. More...

static const uint32_t	CFGSEL_SUBNET4 = 0x00000001
	Number of IPv4 subnets. More...

static const uint32_t	CFGSEL_SUBNET6 = 0x00000002
	Number of IPv6 subnets. More...

static const uint32_t	CFGSEL_IFACE4 = 0x00000004
	Number of enabled ifaces. More...

static const uint32_t	CFGSEL_IFACE6 = 0x00000008
	Number of v6 ifaces. More...

static const uint32_t	CFGSEL_DDNS = 0x00000010
	DDNS enabled/disabled. More...

static const uint32_t	CFGSEL_SUBNET = 0x00000003
	Number of all subnets. More...

static const uint32_t	CFGSEL_GLOBALS = 0x00000020
	Configured globals. More...

static const uint32_t	CFGSEL_CFG_CTL = 0x00000040
	Config control info. More...

static const uint32_t	CFGSEL_ALL4 = 0x00000035
	IPv4 related config. More...

static const uint32_t	CFGSEL_ALL6 = 0x0000003A
	IPv6 related config. More...

static const uint32_t	CFGSEL_ALL = 0xFFFFFFFF
	Whole config. More...

Additional Inherited Members
Protected Member Functions inherited from isc::process::ConfigBase
void	copy (ConfigBase &new_config) const
	Copies the current configuration to a new configuration. More...

Protected Attributes inherited from isc::data::UserContext
data::ConstElementPtr	user_context_
	Pointer to the user context (may be NULL) More...

Detailed Description

Specifies current DHCP configuration.

Todo:: Migrate all other configuration parameters from cfgmgr.h here

Definition at line 167 of file srv_config.h.

Constructor & Destructor Documentation

isc::dhcp::SrvConfig::SrvConfig ( )

Default constructor.

This constructor sets configuration sequence number to 0.

Definition at line 33 of file srv_config.cc.

isc::dhcp::SrvConfig::SrvConfig ( const uint32_t sequence )

Constructor.

Sets arbitrary configuration sequence number.

Definition at line 52 of file srv_config.cc.

Member Function Documentation

void isc::dhcp::SrvConfig::addConfiguredGlobal	(	const std::string &	name,
		isc::data::ConstElementPtr	value
	)

inline

Adds a parameter to the collection configured globals.

Parameters

name	std::string name of the global to add
value	ElementPtr containing the value of the global

Definition at line 792 of file srv_config.h.

Referenced by applyDefaultsConfiguredGlobals(), and extractConfiguredGlobals().

void isc::dhcp::SrvConfig::applyDefaultsConfiguredGlobals ( const isc::data::SimpleDefaults & defaults )

Applies defaults to global parameters.

Parameters

defaults vector of (name, type, value) defaults to apply.

Definition at line 330 of file srv_config.cc.

References addConfiguredGlobal(), getConfiguredGlobals(), and isc_throw.

Here is the call graph for this function:

void isc::dhcp::SrvConfig::clearConfiguredGlobals ( )

Removes all configured global parameters.

Note: This removes the default values too so either applyDefaultsConfiguredGlobals and mergeGlobals, or isc::data::SimpleParser::setDefaults and extractConfiguredGlobals should be called after.

Definition at line 325 of file srv_config.cc.

References isc::data::Element::createMap().

Here is the call graph for this function:

void isc::dhcp::SrvConfig::configureLowerLevelLibraries ( ) const

Convenience method to propagate configuration parameters through inversion of control.

To be used as a last resort when CfgMgr::instance().getCurrentCfg() can't be easily called from where the configuration parameter is used, usually because that particular library is lower in the dependency tree. Happens on configuration commit.

Definition at line 896 of file srv_config.cc.

References isc::dhcp::Option::lenient_parsing_.

void isc::dhcp::SrvConfig::copy ( SrvConfig & new_config ) const

Copies the current configuration to a new configuration.

This method copies the parameters stored in the configuration to an object passed as parameter. The configuration sequence is not copied.

Warning: Some of the configuration objects are not copied at this point, e.g. subnets. This is because they contain quite complex data structures and they make use of pointers, so in many cases the default copy constructors can't be used. Implementing this requires quite a lot of time so this is left as is for now. The lack of ability to copy the entire configuration makes revert function of the CfgMgr unusable.

Parameters

[out] new_config An object to which the configuration will be copied.

Definition at line 118 of file srv_config.cc.

References isc::hooks::HooksConfig::add(), isc::hooks::HooksConfig::clear(), isc::data::copy(), getD2ClientConfig(), and setD2ClientConfig().

Here is the call graph for this function:

bool isc::dhcp::SrvConfig::equals ( const SrvConfig & other ) const

Compares two objects for equality.

It ignores the configuration sequence number when checking for equality of objects.

Parameters

other An object to be compared with this object.

Returns: true if two objects are equal, false otherwise.

Definition at line 141 of file srv_config.cc.

References isc::hooks::HooksConfig::equal(), and isc::hooks::HooksConfig::get().

Referenced by nequals(), and operator==().

Here is the call graph for this function:

void isc::dhcp::SrvConfig::extractConfiguredGlobals ( isc::data::ConstElementPtr config )

Saves scalar elements from the global scope of a configuration.

Definition at line 401 of file srv_config.cc.

References addConfiguredGlobal(), and isc_throw.

Here is the call graph for this function:

CfgDbAccessPtr isc::dhcp::SrvConfig::getCfgDbAccess ( )

inline

Returns pointer to the object holding configuration of the lease and host database connection parameters.

Definition at line 417 of file srv_config.h.

Referenced by setIPReservationsUnique().

ConstCfgDbAccessPtr isc::dhcp::SrvConfig::getCfgDbAccess ( ) const

inline

Returns const pointer to the object holding configuration of the lease and host database connection parameters.

Definition at line 423 of file srv_config.h.

CfgDUIDPtr isc::dhcp::SrvConfig::getCfgDUID ( )

inline

Returns pointer to the object holding configuration of the server identifier.

Definition at line 405 of file srv_config.h.

ConstCfgDUIDPtr isc::dhcp::SrvConfig::getCfgDUID ( ) const

inline

Returns const pointer to the object holding configuration of the server identifier.

Definition at line 411 of file srv_config.h.

CfgExpirationPtr isc::dhcp::SrvConfig::getCfgExpiration ( )

inline

Returns pointer to the object holding configuration pertaining to processing expired leases.

Definition at line 393 of file srv_config.h.

ConstCfgExpirationPtr isc::dhcp::SrvConfig::getCfgExpiration ( ) const

inline

Returns pointer to the const object holding configuration pertaining to processing expired leases.

Definition at line 399 of file srv_config.h.

CfgHostOperationsPtr isc::dhcp::SrvConfig::getCfgHostOperations4 ( )

inline

Returns pointer to the object holding general configuration for host reservations in DHCPv4.

Definition at line 429 of file srv_config.h.

ConstCfgHostOperationsPtr isc::dhcp::SrvConfig::getCfgHostOperations4 ( ) const

inline

Returns const pointer to the object holding general configuration for host reservations in DHCPv4.

Definition at line 435 of file srv_config.h.

CfgHostOperationsPtr isc::dhcp::SrvConfig::getCfgHostOperations6 ( )

inline

Returns pointer to the object holding general configuration for host reservations in DHCPv6.

Definition at line 441 of file srv_config.h.

ConstCfgHostOperationsPtr isc::dhcp::SrvConfig::getCfgHostOperations6 ( ) const

inline

Returns const pointer to the object holding general configuration for host reservations in DHCPv6.

Definition at line 447 of file srv_config.h.

CfgHostsPtr isc::dhcp::SrvConfig::getCfgHosts ( )

inline

Returns pointer to the non-const objects representing host reservations for different IPv4 and IPv6 subnets.

Returns: Pointer to the non-const object holding host reservations.

Definition at line 361 of file srv_config.h.

Referenced by setIPReservationsUnique().

ConstCfgHostsPtr isc::dhcp::SrvConfig::getCfgHosts ( ) const

inline

Returns pointer to the const objects representing host reservations for different IPv4 and IPv6 subnets.

Returns: Pointer to the const object holding host reservations.

Definition at line 369 of file srv_config.h.

CfgIfacePtr isc::dhcp::SrvConfig::getCfgIface ( )

inline

Returns non-const pointer to interface configuration.

This function returns a non-const pointer to the interface configuration.

Returns: Object representing configuration of interfaces.

Definition at line 251 of file srv_config.h.

ConstCfgIfacePtr isc::dhcp::SrvConfig::getCfgIface ( ) const

inline

Returns const pointer to interface configuration.

This function returns a const pointer to the interface configuration.

Returns: Object representing configuration of interfaces.

Definition at line 261 of file srv_config.h.

CfgOptionPtr isc::dhcp::SrvConfig::getCfgOption ( )

inline

Returns pointer to the non-const object holding options.

This method returns a pointer to the object which holds instances of the options to be returned to the clients belonging to any subnet.

Returns: Pointer to the object holding options.

Definition at line 293 of file srv_config.h.

Referenced by merge().

const ConstCfgOptionPtr isc::dhcp::SrvConfig::getCfgOption ( ) const

inline

Returns pointer to the const object holding options.

This method returns a pointer to the object which holds instances of the options to be returned to the clients belonging to any subnet.

Returns: Pointer to the object holding options.

Definition at line 303 of file srv_config.h.

CfgOptionDefPtr isc::dhcp::SrvConfig::getCfgOptionDef ( )

inline

Return pointer to non-const object representing user-defined option definitions.

This function returns a pointer to the object which represents the user defined option definitions grouped by option space name.

Returns: Pointer to an object holding option definitions.

Definition at line 272 of file srv_config.h.

Referenced by merge().

ConstCfgOptionDefPtr isc::dhcp::SrvConfig::getCfgOptionDef ( ) const

inline

Returns pointer to the const object representing user-defined option definitions.

This function returns a pointer to the object which represents the user defined option definitions grouped by option space name.

Returns: Pointer to an object holding option definitions.

Definition at line 283 of file srv_config.h.

CfgRSOOPtr isc::dhcp::SrvConfig::getCfgRSOO ( )

inline

Returns pointer to the non-const object representing set of RSOO-enabled options.

Returns: Pointer to the non-const object holding RSOO-enabled options.

Definition at line 378 of file srv_config.h.

ConstCfgRSOOPtr isc::dhcp::SrvConfig::getCfgRSOO ( ) const

inline

Returns pointer to the const object representing set of RSOO-enabled options.

Returns: Pointer to the const object holding RSOO-enabled options.

Definition at line 387 of file srv_config.h.

CfgSharedNetworks4Ptr isc::dhcp::SrvConfig::getCfgSharedNetworks4 ( ) const

inline

Returns pointer to non-const object holding configuration of shared networks in DHCPv4;.

Returns: Pointer to the object holding shared networks configuration for DHCPv4.

Definition at line 320 of file srv_config.h.

CfgSharedNetworks6Ptr isc::dhcp::SrvConfig::getCfgSharedNetworks6 ( ) const

inline

Returns pointer to non-const object holding configuration of shared networks in DHCPv6.

Returns: Pointer to the object holding shared networks configuration for DHCPv6.

Definition at line 329 of file srv_config.h.

CfgSubnets4Ptr isc::dhcp::SrvConfig::getCfgSubnets4 ( )

inline

Returns pointer to non-const object holding subnets configuration for DHCPv4.

Returns: Pointer to the object holding subnets configuration for DHCPv4.

Definition at line 311 of file srv_config.h.

Referenced by getConfigSummary(), removeStatistics(), and updateStatistics().

ConstCfgSubnets4Ptr isc::dhcp::SrvConfig::getCfgSubnets4 ( ) const

inline

Returns pointer to const object holding subnets configuration for DHCPv4.

Returns: Pointer to the object holding subnets configuration for DHCPv4.

Definition at line 337 of file srv_config.h.

CfgSubnets6Ptr isc::dhcp::SrvConfig::getCfgSubnets6 ( )

inline

Returns pointer to non-const object holding subnets configuration for DHCPv6.

Returns: Pointer to the object holding subnets configuration for DHCPv6.

Definition at line 345 of file srv_config.h.

Referenced by getConfigSummary(), removeStatistics(), and updateStatistics().

ConstCfgSubnets6Ptr isc::dhcp::SrvConfig::getCfgSubnets6 ( ) const

inline

Returns pointer to const object holding subnets configuration for DHCPv6.

Returns: Pointer to the object holding subnets configuration for DHCPv6.

Definition at line 353 of file srv_config.h.

ClientClassDictionaryPtr isc::dhcp::SrvConfig::getClientClassDictionary ( )

inline

Returns pointer to the dictionary of global client class definitions.

Definition at line 512 of file srv_config.h.

const ClientClassDictionaryPtr isc::dhcp::SrvConfig::getClientClassDictionary ( ) const

inline

Returns pointer to const dictionary of global client class definitions.

Definition at line 518 of file srv_config.h.

std::string isc::dhcp::SrvConfig::getConfigSummary ( const uint32_t selection ) const

Returns summary of the configuration in the textual format.

This method returns the brief text describing the current configuration. It may be used for logging purposes, e.g. when the new configuration is committed to notify a user about the changes in configuration.

Todo:: Currently this method uses CfgMgr accessors to get the configuration parameters. Once these parameters are migrated from the CfgMgr this method will have to be modified accordingly.

Todo:: Implement reporting a summary of interfaces being used for receiving and sending DHCP messages. This will be implemented with ticket #3512.

Parameters

selection Is a bitfield which describes the parts of the configuration to be returned.

Returns: Summary of the configuration in the textual format.

Definition at line 72 of file srv_config.cc.

References CFGSEL_DDNS, CFGSEL_SUBNET4, CFGSEL_SUBNET6, getCfgSubnets4(), getCfgSubnets6(), and getD2ClientConfig().

Here is the call graph for this function:

isc::data::ConstElementPtr isc::dhcp::SrvConfig::getConfiguredGlobal ( std::string name ) const

Returns pointer to a given configured global parameter.

Parameters

name	name of the parameter to fetch

Returns: Pointer to the parameter if it exists, otherwise an empty pointer.

Definition at line 315 of file srv_config.cc.

Referenced by sanityChecksLifetime(), and updateStatistics().

isc::data::ConstElementPtr isc::dhcp::SrvConfig::getConfiguredGlobals ( ) const

inline

Returns pointer to configured global parameters.

Definition at line 765 of file srv_config.h.

Referenced by applyDefaultsConfiguredGlobals().

CfgConsistencyPtr isc::dhcp::SrvConfig::getConsistency ( )

inline

Returns const pointer to object holding sanity checks flags.

Definition at line 452 of file srv_config.h.

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

const isc::data::ConstElementPtr isc::dhcp::SrvConfig::getControlSocketInfo ( ) const

inline

Returns information about control socket.

Returns: pointer to the Element that holds control-socket map

Definition at line 476 of file srv_config.h.

D2ClientConfigPtr isc::dhcp::SrvConfig::getD2ClientConfig ( )

inline

Returns pointer to the D2 client configuration.

Definition at line 749 of file srv_config.h.

Referenced by copy(), getConfigSummary(), and getDdnsParams().

const D2ClientConfigPtr isc::dhcp::SrvConfig::getD2ClientConfig ( ) const

inline

Returns pointer to const D2 client configuration.

Definition at line 754 of file srv_config.h.

DdnsParamsPtr isc::dhcp::SrvConfig::getDdnsParams ( const Subnet4Ptr & subnet ) const

Fetches the DDNS parameters for a given DHCPv4 subnet.

Creates a DdnsParams structure which retain and thereafter use the given subnet to fetch DDNS behavioral parameters. The values are fetched with the inheritance scope mode of Network::ALL.

Parameters

subnet DHCPv4 Subnet for which DDNS parameters are desired.

Returns: pointer to DddnParams instance

Definition at line 825 of file srv_config.cc.

References getD2ClientConfig().

Here is the call graph for this function:

DdnsParamsPtr isc::dhcp::SrvConfig::getDdnsParams ( const Subnet6Ptr & subnet ) const

Fetches the DDNS parameters for a given DHCPv6 subnet.

Creates a DdnsParams structure which retain and thereafter use the given subnet to fetch DDNS behavioral parameters. The values are fetched with the inheritance scope mode of Network::ALL.

Parameters

subnet DHCPv6 Subnet for which DDNS parameters are desired.

Returns: pointer to DddnParams instance

Definition at line 831 of file srv_config.cc.

References getD2ClientConfig().

Here is the call graph for this function:

uint32_t isc::dhcp::SrvConfig::getDeclinePeriod ( ) const

inline

Returns probation-period.

See setDeclinePeriod for brief discussion.

Returns: value of probation-period, expressed in seconds

Definition at line 710 of file srv_config.h.

uint16_t isc::dhcp::SrvConfig::getDhcp4o6Port ( ) const

inline

Returns DHCP4o6 IPC port.

See setDhcp4o6Port for brief discussion.

Returns: value of DHCP4o6 IPC port

Definition at line 744 of file srv_config.h.

const isc::data::ConstElementPtr isc::dhcp::SrvConfig::getDHCPMultiThreading ( ) const

inline

Returns DHCP multi threading information.

Returns: pointer to the DHCP multi threading information

Definition at line 500 of file srv_config.h.

Referenced by toElement().

const isc::data::ConstElementPtr isc::dhcp::SrvConfig::getDHCPQueueControl ( ) const

inline

Returns DHCP queue control information.

Returns: pointer to the DHCP queue control information

Definition at line 488 of file srv_config.h.

Referenced by toElement().

bool isc::dhcp::SrvConfig::getEchoClientId ( ) const

inline

Returns whether server should send back client-id in DHCPv4.

Returns: true if client-id should be returned, false otherwise.

Definition at line 726 of file srv_config.h.

isc::hooks::HooksConfig& isc::dhcp::SrvConfig::getHooksConfig ( )

inline

Returns non-const reference to configured hooks libraries.

Returns: non-const reference to configured hooks libraries.

Definition at line 531 of file srv_config.h.

const isc::hooks::HooksConfig& isc::dhcp::SrvConfig::getHooksConfig ( ) const

inline

Returns const reference to configured hooks libraries.

Returns: const reference to configured hooks libraries.

Definition at line 538 of file srv_config.h.

bool isc::dhcp::SrvConfig::getLenientOptionParsing ( ) const

inline

Get lenient option parsing compatibility flag.

Returns: the configured value for lenient option parsing

Definition at line 861 of file srv_config.h.

CfgMACSource& isc::dhcp::SrvConfig::getMACSources ( )

inline

Returns non-const reference to an array that stores MAC/hardware address sources.

Returns: non-const reference to MAC/hardware address sources

Definition at line 462 of file srv_config.h.

const CfgMACSource& isc::dhcp::SrvConfig::getMACSources ( ) const

inline

Returns const reference to an array that stores MAC/hardware address sources.

Returns: const reference to MAC/hardware address sources

Definition at line 470 of file srv_config.h.

uint32_t isc::dhcp::SrvConfig::getSequence ( ) const

inline

Returns configuration sequence number.

Definition at line 229 of file srv_config.h.

Referenced by sequenceEquals().

void isc::dhcp::SrvConfig::merge ( ConfigBase & other )

virtual

Merges the configuration specified as a parameter into this configuration.

This method is used when two or more configurations held in the SrvConfig objects need to be combined into a single configuration. Specifically, when the configuration backend is used, then part of the server configuration comes from the configuration file and stored in the staging configuration. The other part of the configuration comes from the database. The configuration fetched from the database is stored in a separate SrvConfig instance and then merged into the staging configuration prior to committing it.

The merging strategy depends on the underlying data being merged. For example: subnets are merged using the algorithm implemented in the CfgSubnets4. Other data structures are merged using the algorithms implemented in their respective configuration containers.

The general rule is that the configuration data from the other object replaces configuration data held in this object instance. The data that do not overlap between the two objects is simply inserted into this configuration.

Warning: The call to merge may modify the data in the other object. Therefore, the caller must not rely on the data held in the other object after the call to merge. Also, the data held in other must not be modified after the call to merge because it may affect the merged configuration.

The other parameter must be a SrvConfig or its derivation.

This method calls either merge4 or merge6 based on

Currently, the following parts of the configuration are merged:

globals
option definitions
options
via merge4 or merge6 depending on CfgMgr::family_:
- shared networks
- subnets

Todo:: Add support for merging other configuration elements.

Parameters

other An object holding the configuration to be merged into this configuration.

Definition at line 167 of file srv_config.cc.

References getCfgOption(), getCfgOptionDef(), isc::dhcp::CfgMgr::getFamily(), isc::dhcp::CfgMgr::instance(), isc_throw, and isc::data::merge().

Here is the call graph for this function:

void isc::dhcp::SrvConfig::moveDdnsParams ( isc::data::ElementPtr srv_elem )

static

Moves deprecated parameters from dhcp-ddns element to global element.

Given a server configuration element map, the following parameters are moved from dhcp-ddns to top-level (i.e. global) element if they do not already exist there:

From dhcp-ddns:            To (global):
------------------------------------------------------
override-no-update         ddns-override-no-update
override-client-update     ddns-override-client-update
replace-client-name        ddns-replace-client-name
generated-prefix           ddns-generated-prefix
qualifying-suffix          ddns-qualifying-suffix
hostname-char-set          hostname-char-set
hostname-char-replacement  hostname-char-replacement

Note that the whether or not the deprecated parameters are added to the global element, they are always removed from the dhcp-ddns element.

Parameters

srv_elem server top level map to alter

Definition at line 837 of file srv_config.cc.

References isc::dhcp::DHCPSRV_CFGMGR_DDNS_PARAMETER_IGNORED, isc::dhcp::DHCPSRV_CFGMGR_DDNS_PARAMETER_MOVED, isc::dhcp::dhcpsrv_logger, isc_throw, and LOG_INFO.

bool isc::dhcp::SrvConfig::nequals ( const SrvConfig & other ) const

inline

Compares two objects for inequality.

It ignores the configuration sequence number when checking for inequality of objects.

Parameters

other An object to be compared with this object.

Returns: true if two objects are not equal, false otherwise.

Definition at line 604 of file srv_config.h.

References equals().

Referenced by operator!=().

Here is the call graph for this function:

bool isc::dhcp::SrvConfig::operator!= ( const SrvConfig & other ) const

inline

other An object to be compared with this object.

It ignores the configuration sequence number when checking for inequality of objects.

Parameters

other An object to be compared with this object.

Returns: true if two objects are not equal, false otherwise.

Definition at line 628 of file srv_config.h.

References nequals().

Here is the call graph for this function:

bool isc::dhcp::SrvConfig::operator== ( const SrvConfig & other ) const

inline

Equality operator.

It ignores the configuration sequence number when checking for equality of objects.

Parameters

other An object to be compared with this object.

Returns: true if two objects are equal, false otherwise.

Definition at line 616 of file srv_config.h.

References equals().

Here is the call graph for this function:

void isc::dhcp::SrvConfig::removeStatistics ( )

Removes statistics.

This method calls appropriate methods in child objects that remove related statistics. See CfgSubnets4::removeStatistics and CfgSubnets6::removeStatistics for details.

Definition at line 269 of file srv_config.cc.

References getCfgSubnets4(), and getCfgSubnets6().

Here is the call graph for this function:

void isc::dhcp::SrvConfig::sanityChecksLifetime ( const std::string & name ) const

Conducts sanity checks on global lifetime parameters.

Parameters

name	Base name of the lifetime parameter.

Definition at line 416 of file srv_config.cc.

References getConfiguredGlobal(), and isc_throw.

Here is the call graph for this function:

void isc::dhcp::SrvConfig::sanityChecksLifetime	(	const SrvConfig &	target_config,
		const std::string &	name
	)		const

Conducts sanity checks on global lifetime parameters before merge from the external configuration to the target one.

Parameters

target_config	Target configuration.
name	Base name of the lifetime parameter.

Definition at line 493 of file srv_config.cc.

References getConfiguredGlobal(), and isc_throw.

Here is the call graph for this function:

bool isc::dhcp::SrvConfig::sequenceEquals ( const SrvConfig & other )

Compares configuration sequence with other sequence.

This method compares sequence numbers of two configurations for equality. The sequence numbers are meant to be unique, so if they are equal it means that they point to the same configuration.

Parameters

other Configuration which sequence number should be compared with the sequence number of this configuration.

Returns: true if sequence numbers are equal.

Definition at line 113 of file srv_config.cc.

References getSequence().

Here is the call graph for this function:

void isc::dhcp::SrvConfig::setClientClassDictionary ( const ClientClassDictionaryPtr & dictionary )

inline

Sets the client class dictionary.

Parameters

dictionary pointer to the new class dictionary

Definition at line 524 of file srv_config.h.

void isc::dhcp::SrvConfig::setControlSocketInfo ( const isc::data::ConstElementPtr & control_socket )

inline

Sets information about the control socket.

Parameters

control_socket Element that holds control-socket map

Definition at line 482 of file srv_config.h.

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

void isc::dhcp::SrvConfig::setD2ClientConfig ( const D2ClientConfigPtr & d2_client_config )

inline

Sets the D2 client configuration.

Parameters

d2_client_config pointer to the new D2 client configuration

Definition at line 760 of file srv_config.h.

Referenced by copy().

void isc::dhcp::SrvConfig::setDeclinePeriod ( const uint32_t decline_timer )

inline

Sets decline probation-period.

Probation-period is the timer, expressed, in seconds, that specifies how long a lease is unavailable after reported as declined.

Parameters

decline_timer number of seconds after declined lease is restored

Definition at line 702 of file srv_config.h.

void isc::dhcp::SrvConfig::setDhcp4o6Port ( uint16_t port )

inline

Sets DHCP4o6 IPC port.

DHCPv4-over-DHCPv6 uses a UDP socket for interserver communication, this socket is bound and connected to this port and port + 1

Parameters

port	port and port + 1 to use

Definition at line 736 of file srv_config.h.

void isc::dhcp::SrvConfig::setDHCPMultiThreading ( const isc::data::ConstElementPtr dhcp_multi_threading )

inline

Sets information about the dhcp multi threading.

Parameters

dhcp_multi_threading new dhcp multi threading information

Definition at line 506 of file srv_config.h.

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

void isc::dhcp::SrvConfig::setDHCPQueueControl ( const isc::data::ConstElementPtr dhcp_queue_control )

inline

Sets information about the dhcp queue control.

Parameters

dhcp_queue_control new dhcp queue control information

Definition at line 494 of file srv_config.h.

void isc::dhcp::SrvConfig::setEchoClientId ( const bool echo )

inline

Sets whether server should send back client-id in DHCPv4.

This is a compatibility flag. The default (true) is compliant with RFC6842. False is for backward compatibility.

Parameters

echo	should the client-id be sent or not

Definition at line 720 of file srv_config.h.

void isc::dhcp::SrvConfig::setIPReservationsUnique ( const bool unique )

Configures the server to allow or disallow specifying multiple hosts with the same IP address/subnet.

This setting is applied in CfgDbAccess and CfgHosts. This function should be called when the server is being configured using the configuration file, config-set command or via the configuration backend.

Parameters

unique Boolean value indicating if it is allowed (when false) or disallowed to specify multiple hosts with the same IP reservation.

Definition at line 887 of file srv_config.cc.

References isc::dhcp::DHCPSRV_CFGMGR_IP_RESERVATIONS_UNIQUE_DUPLICATES_POSSIBLE, isc::dhcp::dhcpsrv_logger, getCfgDbAccess(), getCfgHosts(), and LOG_WARN.

Here is the call graph for this function:

void isc::dhcp::SrvConfig::setLenientOptionParsing ( bool const value )

inline

Set lenient option parsing compatibility flag.

Parameters

value the boolean value to be set when configuring lenient option parsing

Definition at line 854 of file srv_config.h.

ElementPtr isc::dhcp::SrvConfig::toElement ( ) const

virtual

Unparse a configuration object.

Returns: a pointer to unparsed configuration

Todo:: accept empty list

Reimplemented from isc::process::ConfigBase.

Definition at line 605 of file srv_config.cc.

References isc::data::UserContext::contextToElement(), isc::dhcp::CfgHostsList::get(), isc::process::ConfigBase::getConfigControlInfo(), isc::dhcp::CfgMgr::getDataDir(), getDHCPMultiThreading(), getDHCPQueueControl(), isc::dhcp::CfgMgr::getFamily(), isc::db::info, isc::dhcp::CfgMgr::instance(), isc::dhcp::CfgHostsList::internalize(), isc_throw, isc::data::isNull(), isc::dhcp::CfgMACSource::toElement(), isc::hooks::HooksConfig::toElement(), isc::dhcp::CfgLeaseDbAccess::toElement(), isc::dhcp::CfgHostDbAccess::toElement(), and isc::util::Optional< T >::unspecified().

Here is the call graph for this function:

void isc::dhcp::SrvConfig::updateStatistics ( )

Updates statistics.

This method calls appropriate methods in child objects that update related statistics. See CfgSubnets4::updateStatistics and CfgSubnets6::updateStatistics for details.

Definition at line 277 of file srv_config.cc.

References getCfgSubnets4(), getCfgSubnets6(), getConfiguredGlobal(), isc::dhcp::LeaseMgrFactory::haveInstance(), isc::stats::StatsMgr::instance(), isc::stats::StatsMgr::setMaxSampleAgeAll(), isc::stats::StatsMgr::setMaxSampleAgeDefault(), isc::stats::StatsMgr::setMaxSampleCountAll(), and isc::stats::StatsMgr::setMaxSampleCountDefault().

Here is the call graph for this function:

Member Data Documentation

const uint32_t isc::dhcp::SrvConfig::CFGSEL_ALL = 0xFFFFFFFF

static

Whole config.

Definition at line 195 of file srv_config.h.

const uint32_t isc::dhcp::SrvConfig::CFGSEL_ALL4 = 0x00000035

static

IPv4 related config.

Definition at line 191 of file srv_config.h.

const uint32_t isc::dhcp::SrvConfig::CFGSEL_ALL6 = 0x0000003A

static

IPv6 related config.

Definition at line 193 of file srv_config.h.

const uint32_t isc::dhcp::SrvConfig::CFGSEL_CFG_CTL = 0x00000040

static

Config control info.

Definition at line 189 of file srv_config.h.

const uint32_t isc::dhcp::SrvConfig::CFGSEL_DDNS = 0x00000010

static

DDNS enabled/disabled.

Definition at line 183 of file srv_config.h.

Referenced by getConfigSummary().

const uint32_t isc::dhcp::SrvConfig::CFGSEL_GLOBALS = 0x00000020

static

Configured globals.

Definition at line 187 of file srv_config.h.

const uint32_t isc::dhcp::SrvConfig::CFGSEL_IFACE4 = 0x00000004

static

Number of enabled ifaces.

Definition at line 179 of file srv_config.h.

const uint32_t isc::dhcp::SrvConfig::CFGSEL_IFACE6 = 0x00000008

static

Number of v6 ifaces.

Definition at line 181 of file srv_config.h.

const uint32_t isc::dhcp::SrvConfig::CFGSEL_NONE = 0x00000000

static

Nothing selected.

Definition at line 173 of file srv_config.h.

const uint32_t isc::dhcp::SrvConfig::CFGSEL_SUBNET = 0x00000003

static

Number of all subnets.

Definition at line 185 of file srv_config.h.

const uint32_t isc::dhcp::SrvConfig::CFGSEL_SUBNET4 = 0x00000001

static

Number of IPv4 subnets.

Definition at line 175 of file srv_config.h.

Referenced by getConfigSummary().

const uint32_t isc::dhcp::SrvConfig::CFGSEL_SUBNET6 = 0x00000002

static

Number of IPv6 subnets.

Definition at line 177 of file srv_config.h.

Referenced by getConfigSummary().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation