Implementation of the Configuration Backend Pool for DHCPv4. More...

#include <config_backend_pool_dhcp4.h>

Inheritance diagram for isc::dhcp::ConfigBackendPoolDHCPv4:

Public Member Functions
virtual void	createUpdateClientClass4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const ClientClassDefPtr &client_class, const std::string &follow_class_name)
	Creates or updates DHCPv4 client class.

virtual void	createUpdateGlobalParameter4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const data::StampedValuePtr &value)
	Creates or updates global string parameter.

virtual void	createUpdateOption4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const asiolink::IOAddress &pool_start_address, const asiolink::IOAddress &pool_end_address, const OptionDescriptorPtr &option)
	Creates or updates pool level option.

virtual void	createUpdateOption4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const OptionDescriptorPtr &option)
	Creates or updates global option.

virtual void	createUpdateOption4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const std::string &shared_network_name, const OptionDescriptorPtr &option)
	Creates or updates shared network level option.

virtual void	createUpdateOption4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const SubnetID &subnet_id, const OptionDescriptorPtr &option)
	Creates or updates subnet level option.

virtual void	createUpdateOptionDef4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const OptionDefinitionPtr &option_def)
	Creates or updates an option definition.

virtual void	createUpdateServer4 (const db::BackendSelector &backend_selector, const db::ServerPtr &server)
	Creates or updates a server.

virtual void	createUpdateSharedNetwork4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const SharedNetwork4Ptr &shared_network)
	Creates or updates a shared network.

virtual void	createUpdateSubnet4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const Subnet4Ptr &subnet)
	Creates or updates a subnet.

virtual uint64_t	deleteAllClientClasses4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector)
	Deletes all client classes.

virtual uint64_t	deleteAllGlobalParameters4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector)
	Deletes all global parameters.

virtual uint64_t	deleteAllOptionDefs4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector)
	Deletes all option definitions.

virtual uint64_t	deleteAllServers4 (const db::BackendSelector &backend_selector)
	Deletes all servers from the backend except the logical server 'all'.

virtual uint64_t	deleteAllSharedNetworks4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector)
	Deletes all shared networks.

virtual uint64_t	deleteAllSubnets4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector)
	Deletes all subnets.

virtual uint64_t	deleteClientClass4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const std::string &name)
	Deletes DHCPv4 client class.

virtual uint64_t	deleteGlobalParameter4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const std::string &name)
	Deletes global parameter.

virtual uint64_t	deleteOption4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const asiolink::IOAddress &pool_start_address, const asiolink::IOAddress &pool_end_address, const uint16_t code, const std::string &space)
	Deletes pool level option.

virtual uint64_t	deleteOption4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const std::string &shared_network_name, const uint16_t code, const std::string &space)
	Deletes shared network level option.

virtual uint64_t	deleteOption4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const SubnetID &subnet_id, const uint16_t code, const std::string &space)
	Deletes subnet level option.

virtual uint64_t	deleteOption4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const uint16_t code, const std::string &space)
	Deletes global option.

virtual uint64_t	deleteOptionDef4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const uint16_t code, const std::string &space)
	Deletes option definition.

virtual uint64_t	deleteServer4 (const db::BackendSelector &backend_selector, const data::ServerTag &server_tag)
	Deletes a server from the backend.

virtual uint64_t	deleteSharedNetwork4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const std::string &name)
	Deletes shared network by name.

virtual uint64_t	deleteSharedNetworkSubnets4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const std::string &shared_network_name)
	Deletes all subnets belonging to a specified shared network.

virtual uint64_t	deleteSubnet4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const std::string &subnet_prefix)
	Deletes subnet by prefix.

virtual uint64_t	deleteSubnet4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const SubnetID &subnet_id)
	Deletes subnet by identifier.

virtual ClientClassDictionary	getAllClientClasses4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector) const
	Retrieves all client classes.

virtual data::StampedValueCollection	getAllGlobalParameters4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector) const
	Retrieves all global parameters.

virtual OptionDefContainer	getAllOptionDefs4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector) const
	Retrieves all option definitions.

virtual OptionContainer	getAllOptions4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector) const
	Retrieves all global options.

virtual db::ServerCollection	getAllServers4 (const db::BackendSelector &backend_selector) const
	Retrieves all servers from the particular backend.

virtual SharedNetwork4Collection	getAllSharedNetworks4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector) const
	Retrieves all shared networks.

virtual Subnet4Collection	getAllSubnets4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector) const
	Retrieves all subnets.

virtual ClientClassDefPtr	getClientClass4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const std::string &name) const
	Retrieves a client class by name.

virtual data::StampedValuePtr	getGlobalParameter4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const std::string &name) const
	Retrieves global parameter value.

virtual ClientClassDictionary	getModifiedClientClasses4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const boost::posix_time::ptime &modification_time) const
	Retrieves client classes modified after specified time.

virtual data::StampedValueCollection	getModifiedGlobalParameters4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const boost::posix_time::ptime &modification_time) const
	Retrieves global parameters modified after specified time.

virtual OptionDefContainer	getModifiedOptionDefs4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const boost::posix_time::ptime &modification_time) const
	Retrieves option definitions modified after specified time.

virtual OptionContainer	getModifiedOptions4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const boost::posix_time::ptime &modification_time) const
	Retrieves option modified after specified time.

virtual SharedNetwork4Collection	getModifiedSharedNetworks4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const boost::posix_time::ptime &modification_time) const
	Retrieves shared networks modified after specified time.

virtual Subnet4Collection	getModifiedSubnets4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const boost::posix_time::ptime &modification_time) const
	Retrieves subnets modified after specified time.

virtual OptionDescriptorPtr	getOption4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const uint16_t code, const std::string &space) const
	Retrieves single option by code and space.

virtual OptionDefinitionPtr	getOptionDef4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const uint16_t code, const std::string &space) const
	Retrieves single option definition by code and space.

virtual db::AuditEntryCollection	getRecentAuditEntries (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const boost::posix_time::ptime &modification_time, const uint64_t &modification_id) const
	Retrieves the most recent audit entries.

virtual db::ServerPtr	getServer4 (const db::BackendSelector &backend_selector, const data::ServerTag &server_tag) const
	Retrieves a server from the particular backend.

virtual SharedNetwork4Ptr	getSharedNetwork4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const std::string &name) const
	Retrieves shared network by name.

virtual Subnet4Collection	getSharedNetworkSubnets4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const std::string &shared_network_name) const
	Retrieves all subnets belonging to a specified shared network.

virtual Subnet4Ptr	getSubnet4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const std::string &subnet_prefix) const
	Retrieves a single subnet by subnet_prefix.

virtual Subnet4Ptr	getSubnet4 (const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, const SubnetID &subnet_id) const
	Retrieves a single subnet by subnet identifier.

Public Member Functions inherited from isc::cb::BaseConfigBackendPool< ConfigBackendDHCPv4 >
virtual	~BaseConfigBackendPool ()
	Virtual destructor.

void	addBackend (ConfigBackendTypePtr backend)
	Adds a backend to the pool.

bool	del (const std::string &db_type, const std::string &dbaccess, bool if_unusable)
	Deletes all backends of the given type from the pool.

void	delAllBackends ()
	Deletes all backends from the pool.

void	delAllBackends (const std::string &db_type)
	Deletes all backends of the given type from the pool.

Additional Inherited Members
Public Types inherited from isc::cb::BaseConfigBackendPool< ConfigBackendDHCPv4 >
typedef boost::shared_ptr< ConfigBackendDHCPv4 >	ConfigBackendTypePtr
	Shared pointer to the Configuration Backend used.

Protected Member Functions inherited from isc::cb::BaseConfigBackendPool< ConfigBackendDHCPv4 >
ReturnValue	createUpdateDeleteBackendProperty (ReturnValue(ConfigBackendType::*MethodPointer)(FnPtrArgs...), const db::BackendSelector &backend_selector, Args... input)
	Add, update or delete property from the backend.

ReturnValue	createUpdateDeleteProperty (ReturnValue(ConfigBackendType::*MethodPointer)(const db::ServerSelector &, FnPtrArgs...), const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, Args... input)
	Add, update or delete property from the backend.

void	getAllBackendPropertiesConst (PropertyCollectionType(ConfigBackendType::*MethodPointer)() const, const db::BackendSelector &backend_selector, PropertyCollectionType &properties) const
	Get all configuration properties from the backend.

void	getAllPropertiesConst (PropertyCollectionType(ConfigBackendType::*MethodPointer)(const db::ServerSelector &) const, const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, PropertyCollectionType &properties) const
	Retrieve all configuration properties from the pool.

void	getBackendPropertyPtrConst (PropertyType(ConfigBackendType::*MethodPointer)(FnPtrArgs...) const, const db::BackendSelector &backend_selector, PropertyType &property, Args... input) const
	Retrieve a single configuration property from the backend.

void	getMultiplePropertiesConst (PropertyCollectionType(ConfigBackendType::*MethodPointer)(const db::ServerSelector &, FnPtrArgs...) const, const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, PropertyCollectionType &properties, Args... input) const
	Retrieve multiple configuration properties from the pool.

void	getPropertyPtrConst (PropertyType(ConfigBackendType::*MethodPointer)(const db::ServerSelector &, FnPtrArgs...) const, const db::BackendSelector &backend_selector, const db::ServerSelector &server_selector, PropertyType &property, Args... input) const
	Retrieve a single configuration property from the pool.

std::list< ConfigBackendTypePtr >	selectBackends (const db::BackendSelector &backend_selector) const
	Selects existing backends matching the selector.

Protected Attributes inherited from isc::cb::BaseConfigBackendPool< ConfigBackendDHCPv4 >
std::list< ConfigBackendTypePtr >	backends_
	Holds configuration backends belonging to the pool.

Detailed Description

Implementation of the Configuration Backend Pool for DHCPv4.

All POSIX times specified in the methods belonging to this class must be local times.

Definition at line 33 of file config_backend_pool_dhcp4.h.

Member Function Documentation

◆ createUpdateClientClass4()

void isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateClientClass4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const ClientClassDefPtr &	client_class,
		const std::string &	follow_class_name )

virtual

Creates or updates DHCPv4 client class.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
client_class	Client class to be added or updated.
follow_class_name	name of the class after which the new or updated class should be positioned. An empty value causes the class to be appended at the end of the class hierarchy.

Definition at line 346 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::createUpdateClientClass4().

Here is the call graph for this function:

◆ createUpdateGlobalParameter4()

void isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateGlobalParameter4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const data::StampedValuePtr &	value )

virtual

Creates or updates global string parameter.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
value	Value of the global parameter.

Definition at line 337 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::createUpdateGlobalParameter4().

Here is the call graph for this function:

◆ createUpdateOption4() [1/4]

void isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateOption4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const asiolink::IOAddress &	pool_start_address,
		const asiolink::IOAddress &	pool_end_address,
		const OptionDescriptorPtr &	option )

virtual

Creates or updates pool level option.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
pool_start_address	Lower bound address of the pool to which the option belongs.
pool_end_address	Upper bound address of the pool to which the option belongs.
option	Option to be added or updated.

Definition at line 325 of file config_backend_pool_dhcp4.cc.

References isc::cb::BaseConfigBackendPool< ConfigBackendDHCPv4 >::createUpdateDeleteProperty(), and isc::dhcp::ConfigBackendDHCPv4::createUpdateOption4().

Here is the call graph for this function:

◆ createUpdateOption4() [2/4]

void isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateOption4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const OptionDescriptorPtr &	option )

virtual

Creates or updates global option.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
option	Option to be added or updated.

Definition at line 295 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::createUpdateOption4().

Here is the call graph for this function:

◆ createUpdateOption4() [3/4]

void isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateOption4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const std::string &	shared_network_name,
		const OptionDescriptorPtr &	option )

virtual

Creates or updates shared network level option.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
shared_network_name	Name of a shared network to which option belongs.
option	Option to be added or updated.

Definition at line 304 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::createUpdateOption4().

Here is the call graph for this function:

◆ createUpdateOption4() [4/4]

void isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateOption4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const SubnetID &	subnet_id,
		const OptionDescriptorPtr &	option )

virtual

Creates or updates subnet level option.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
subnet_id	Identifier of a subnet to which option belongs.
option	Option to be added or updated.

Definition at line 315 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::createUpdateOption4().

Here is the call graph for this function:

◆ createUpdateOptionDef4()

void isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateOptionDef4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const OptionDefinitionPtr &	option_def )

virtual

Creates or updates an option definition.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
option_def	Option definition to be added or updated.

Definition at line 286 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::createUpdateOptionDef4().

Here is the call graph for this function:

◆ createUpdateServer4()

void isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateServer4	(	const db::BackendSelector &	backend_selector,
		const db::ServerPtr &	server )

virtual

Creates or updates a server.

Parameters

backend_selector	Backend selector.
server	Instance of the server to be stored.

Definition at line 356 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::createUpdateServer4().

Here is the call graph for this function:

◆ createUpdateSharedNetwork4()

void isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateSharedNetwork4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const SharedNetwork4Ptr &	shared_network )

virtual

Creates or updates a shared network.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
shared_network	Shared network to be added or updated.

Definition at line 277 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::createUpdateSharedNetwork4().

Here is the call graph for this function:

◆ createUpdateSubnet4()

void isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateSubnet4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const Subnet4Ptr &	subnet )

virtual

Creates or updates a subnet.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
subnet	Subnet to be added or updated.

Definition at line 268 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::createUpdateSubnet4().

Here is the call graph for this function:

◆ deleteAllClientClasses4()

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteAllClientClasses4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector )

virtual

Deletes all client classes.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.

Returns: Number of deleted client classes.

Definition at line 503 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteAllClientClasses4().

Here is the call graph for this function:

◆ deleteAllGlobalParameters4()

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteAllGlobalParameters4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector )

virtual

Deletes all global parameters.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.

Returns: Number of deleted global parameters.

Definition at line 486 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteAllGlobalParameters4().

Here is the call graph for this function:

◆ deleteAllOptionDefs4()

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteAllOptionDefs4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector )

virtual

Deletes all option definitions.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.

Returns: Number of deleted option definitions.

Definition at line 424 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteAllOptionDefs4().

Here is the call graph for this function:

◆ deleteAllServers4()

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteAllServers4 ( const db::BackendSelector & backend_selector )

virtual

Deletes all servers from the backend except the logical server 'all'.

Parameters

backend_selector Backend selector.

Returns: Number of deleted servers.

Definition at line 518 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteAllServers4().

Here is the call graph for this function:

◆ deleteAllSharedNetworks4()

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteAllSharedNetworks4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector )

virtual

Deletes all shared networks.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.

Returns: Number of deleted shared networks.

Definition at line 407 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteAllSharedNetworks4().

Here is the call graph for this function:

◆ deleteAllSubnets4()

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteAllSubnets4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector )

virtual

Deletes all subnets.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.

Returns: Number of deleted subnets.

Definition at line 382 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteAllSubnets4().

Here is the call graph for this function:

◆ deleteClientClass4()

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteClientClass4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const std::string &	name )

virtual

Deletes DHCPv4 client class.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
name	Name of the class to be deleted.

Returns: Number of deleted client classes.

Definition at line 494 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteClientClass4().

Here is the call graph for this function:

◆ deleteGlobalParameter4()

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteGlobalParameter4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const std::string &	name )

virtual

Deletes global parameter.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
name	Name of the global parameter to be deleted.

Returns: Number of deleted global parameters.

Definition at line 477 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteGlobalParameter4().

Here is the call graph for this function:

◆ deleteOption4() [1/4]

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteOption4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const asiolink::IOAddress &	pool_start_address,
		const asiolink::IOAddress &	pool_end_address,
		const uint16_t	code,
		const std::string &	space )

virtual

Deletes pool level option.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
pool_start_address	Lower bound address of the pool to which deleted option belongs.
pool_end_address	Upper bound address of the pool to which the deleted option belongs.
code	Code of the deleted option.
space	Option space of the deleted option.

Returns: Number of deleted options.

Definition at line 464 of file config_backend_pool_dhcp4.cc.

References isc::cb::BaseConfigBackendPool< ConfigBackendDHCPv4 >::createUpdateDeleteProperty(), and isc::dhcp::ConfigBackendDHCPv4::deleteOption4().

Here is the call graph for this function:

◆ deleteOption4() [2/4]

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteOption4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const std::string &	shared_network_name,
		const uint16_t	code,
		const std::string &	space )

virtual

Deletes shared network level option.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
shared_network_name	Name of the shared network which option belongs to.
code	Code of the option to be deleted.
space	Option space of the option to be deleted.

Definition at line 441 of file config_backend_pool_dhcp4.cc.

References isc::cb::BaseConfigBackendPool< ConfigBackendDHCPv4 >::createUpdateDeleteProperty(), and isc::dhcp::ConfigBackendDHCPv4::deleteOption4().

Here is the call graph for this function:

◆ deleteOption4() [3/4]

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteOption4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const SubnetID &	subnet_id,
		const uint16_t	code,
		const std::string &	space )

virtual

Deletes subnet level option.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
subnet_id	Identifier of the subnet to which deleted option belongs.
code	Code of the deleted option.
space	Option space of the deleted option.

Returns: Number of deleted options.

Definition at line 453 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteOption4().

Here is the call graph for this function:

◆ deleteOption4() [4/4]

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteOption4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const uint16_t	code,
		const std::string &	space )

virtual

Deletes global option.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
code	Code of the option to be deleted.
space	Option space of the option to be deleted.

Returns: Number of deleted options.

Definition at line 431 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteOption4().

Here is the call graph for this function:

◆ deleteOptionDef4()

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteOptionDef4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const uint16_t	code,
		const std::string &	space )

virtual

Deletes option definition.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
code	Code of the option to be deleted.
space	Option space of the option to be deleted.

Returns: Number of deleted option definitions.

Definition at line 414 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteOptionDef4().

Here is the call graph for this function:

◆ deleteServer4()

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteServer4	(	const db::BackendSelector &	backend_selector,
		const data::ServerTag &	server_tag )

virtual

Deletes a server from the backend.

Parameters

backend_selector	Backend selector.
server_tag	Tag of the server to be deleted.

Returns: Number of deleted servers.

Definition at line 510 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteServer4().

Here is the call graph for this function:

◆ deleteSharedNetwork4()

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteSharedNetwork4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const std::string &	name )

virtual

Deletes shared network by name.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
name	Name of the shared network to be deleted.

Returns: Number of deleted shared networks.

Definition at line 398 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteSharedNetwork4().

Here is the call graph for this function:

◆ deleteSharedNetworkSubnets4()

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteSharedNetworkSubnets4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const std::string &	shared_network_name )

virtual

Deletes all subnets belonging to a specified shared network.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
shared_network_name	Name of the shared network for which the subnets should be deleted.

Returns: Number of deleted subnets.

Definition at line 389 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteSharedNetworkSubnets4().

Here is the call graph for this function:

◆ deleteSubnet4() [1/2]

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteSubnet4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const std::string &	subnet_prefix )

virtual

Deletes subnet by prefix.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
subnet_prefix	Prefix of the subnet to be deleted.

Returns: Number of deleted subnets.

Definition at line 364 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteSubnet4().

Here is the call graph for this function:

◆ deleteSubnet4() [2/2]

uint64_t isc::dhcp::ConfigBackendPoolDHCPv4::deleteSubnet4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const SubnetID &	subnet_id )

virtual

Deletes subnet by identifier.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
subnet_id	Identifier of the subnet to be deleted.

Returns: Number of deleted subnets.

Definition at line 373 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::deleteSubnet4().

Here is the call graph for this function:

◆ getAllClientClasses4()

ClientClassDictionary isc::dhcp::ConfigBackendPoolDHCPv4::getAllClientClasses4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector ) const

virtual

Retrieves all client classes.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.

Returns: Collection of client classes.

Definition at line 215 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getAllClientClasses4().

Here is the call graph for this function:

◆ getAllGlobalParameters4()

StampedValueCollection isc::dhcp::ConfigBackendPoolDHCPv4::getAllGlobalParameters4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector ) const

virtual

Retrieves all global parameters.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.

Definition at line 182 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getAllGlobalParameters4().

Here is the call graph for this function:

◆ getAllOptionDefs4()

OptionDefContainer isc::dhcp::ConfigBackendPoolDHCPv4::getAllOptionDefs4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector ) const

virtual

Retrieves all option definitions.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.

Returns: Collection of option definitions or empty collection if no option definition found.

Definition at line 117 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getAllOptionDefs4().

Here is the call graph for this function:

◆ getAllOptions4()

OptionContainer isc::dhcp::ConfigBackendPoolDHCPv4::getAllOptions4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector ) const

virtual

Retrieves all global options.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.

Returns: Collection of global options or empty collection if no option found.

Definition at line 150 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getAllOptions4().

Here is the call graph for this function:

◆ getAllServers4()

ServerCollection isc::dhcp::ConfigBackendPoolDHCPv4::getAllServers4 ( const db::BackendSelector & backend_selector ) const

virtual

Retrieves all servers from the particular backend.

This method returns the list of servers excluding the logical server 'all'.

Parameters

backend_selector Backend selector.

Returns: Collection of servers from the backend.

Definition at line 250 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getAllServers4().

Here is the call graph for this function:

◆ getAllSharedNetworks4()

SharedNetwork4Collection isc::dhcp::ConfigBackendPoolDHCPv4::getAllSharedNetworks4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector ) const

virtual

Retrieves all shared networks.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.

Returns: Collection of shared network or empty collection if no shared network found.

Definition at line 83 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getAllSharedNetworks4().

Here is the call graph for this function:

◆ getAllSubnets4()

Subnet4Collection isc::dhcp::ConfigBackendPoolDHCPv4::getAllSubnets4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector ) const

virtual

Retrieves all subnets.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.

Returns: Collection of subnets or empty collection if no subnet found.

Definition at line 40 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getAllSubnets4().

Here is the call graph for this function:

◆ getClientClass4()

ClientClassDefPtr isc::dhcp::ConfigBackendPoolDHCPv4::getClientClass4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const std::string &	name ) const

virtual

Retrieves a client class by name.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
name	Client class name.

Returns: Pointer to the retrieved client class.

Definition at line 204 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getClientClass4().

Here is the call graph for this function:

◆ getGlobalParameter4()

StampedValuePtr isc::dhcp::ConfigBackendPoolDHCPv4::getGlobalParameter4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const std::string &	name ) const

virtual

Retrieves global parameter value.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
name	Name of the global parameter to be retrieved.

Returns: Value of the global parameter.

Definition at line 171 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getGlobalParameter4().

Here is the call graph for this function:

◆ getModifiedClientClasses4()

ClientClassDictionary isc::dhcp::ConfigBackendPoolDHCPv4::getModifiedClientClasses4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const boost::posix_time::ptime &	modification_time ) const

virtual

Retrieves client classes modified after specified time.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
modification_time	Modification time.

Returns: Collection of client classes.

Definition at line 226 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getModifiedClientClasses4().

Here is the call graph for this function:

◆ getModifiedGlobalParameters4()

StampedValueCollection isc::dhcp::ConfigBackendPoolDHCPv4::getModifiedGlobalParameters4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const boost::posix_time::ptime &	modification_time ) const

virtual

Retrieves global parameters modified after specified time.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
modification_time	Lower bound subnet modification time.

Returns: Collection of modified global parameters.

Definition at line 192 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getModifiedGlobalParameters4().

Here is the call graph for this function:

◆ getModifiedOptionDefs4()

OptionDefContainer isc::dhcp::ConfigBackendPoolDHCPv4::getModifiedOptionDefs4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const boost::posix_time::ptime &	modification_time ) const

virtual

Retrieves option definitions modified after specified time.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
modification_time	Lower bound option definition modification time.

Returns: Collection of option definitions or empty collection if no option definition found.

Definition at line 127 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getModifiedOptionDefs4().

Here is the call graph for this function:

◆ getModifiedOptions4()

OptionContainer isc::dhcp::ConfigBackendPoolDHCPv4::getModifiedOptions4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const boost::posix_time::ptime &	modification_time ) const

virtual

Retrieves option modified after specified time.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
modification_time	Lower bound option modification time.

Returns: Collection of global options or empty collection if no option found.

Definition at line 160 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getModifiedOptions4().

Here is the call graph for this function:

◆ getModifiedSharedNetworks4()

SharedNetwork4Collection isc::dhcp::ConfigBackendPoolDHCPv4::getModifiedSharedNetworks4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const boost::posix_time::ptime &	modification_time ) const

virtual

Retrieves shared networks modified after specified time.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
modification_time	Lower bound shared network modification time.

Returns: Collection of shared network or empty collection if no shared network found.

Definition at line 93 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getModifiedSharedNetworks4().

Here is the call graph for this function:

◆ getModifiedSubnets4()

Subnet4Collection isc::dhcp::ConfigBackendPoolDHCPv4::getModifiedSubnets4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const boost::posix_time::ptime &	modification_time ) const

virtual

Retrieves subnets modified after specified time.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
modification_time	Lower bound subnet modification time.

Returns: Collection of subnets or empty collection if no subnet found.

Definition at line 50 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getModifiedSubnets4().

Here is the call graph for this function:

◆ getOption4()

OptionDescriptorPtr isc::dhcp::ConfigBackendPoolDHCPv4::getOption4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const uint16_t	code,
		const std::string &	space ) const

virtual

Retrieves single option by code and space.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
code	Option code.
space	Option space.

Returns: Pointer to the retrieved option descriptor or null if no option was found.

Definition at line 138 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getOption4().

Here is the call graph for this function:

◆ getOptionDef4()

OptionDefinitionPtr isc::dhcp::ConfigBackendPoolDHCPv4::getOptionDef4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const uint16_t	code,
		const std::string &	space ) const

virtual

Retrieves single option definition by code and space.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
code	Code of the option to be retrieved.
space	Option space of the option to be retrieved.

Returns: Pointer to the option definition or NULL if not found.

Definition at line 105 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getOptionDef4().

Here is the call graph for this function:

◆ getRecentAuditEntries()

AuditEntryCollection isc::dhcp::ConfigBackendPoolDHCPv4::getRecentAuditEntries	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const boost::posix_time::ptime &	modification_time,
		const uint64_t &	modification_id ) const

virtual

Retrieves the most recent audit entries.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
modification_time	Timestamp being a lower limit for the returned result set, i.e. entries later than specified time are returned.
modification_id	Identifier being a lower limit for the returned result set, used when two (or more) entries have the same modification_time.

Returns: Collection of audit entries.

Definition at line 237 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getRecentAuditEntries().

Here is the call graph for this function:

◆ getServer4()

ServerPtr isc::dhcp::ConfigBackendPoolDHCPv4::getServer4	(	const db::BackendSelector &	backend_selector,
		const data::ServerTag &	server_tag ) const

virtual

Retrieves a server from the particular backend.

Parameters

backend_selector	Backend selector.
server_tag	Tag of the server to be retrieved.

Returns: Pointer to the server instance or null pointer if no server with the particular tag was found.

Definition at line 258 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getServer4().

Here is the call graph for this function:

◆ getSharedNetwork4()

SharedNetwork4Ptr isc::dhcp::ConfigBackendPoolDHCPv4::getSharedNetwork4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const std::string &	name ) const

virtual

Retrieves shared network by name.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
name	Name of the shared network to be retrieved.

Returns: Pointer to the shared network or NULL if not found.

Definition at line 72 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getSharedNetwork4().

Here is the call graph for this function:

◆ getSharedNetworkSubnets4()

Subnet4Collection isc::dhcp::ConfigBackendPoolDHCPv4::getSharedNetworkSubnets4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const std::string &	shared_network_name ) const

virtual

Retrieves all subnets belonging to a specified shared network.

Note: : Returning a Subnet4Collection instead of a Subnet4SimpleCollection can be considered as overkilling but makes this code far simpler.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
shared_network_name	Name of the shared network for which the subnets should be retrieved.

Returns: Collection of subnets or empty collection if no subnet found.

Definition at line 61 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getSharedNetworkSubnets4().

Here is the call graph for this function:

◆ getSubnet4() [1/2]

Subnet4Ptr isc::dhcp::ConfigBackendPoolDHCPv4::getSubnet4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const std::string &	subnet_prefix ) const

virtual

Retrieves a single subnet by subnet_prefix.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
subnet_prefix	Prefix of the subnet to be retrieved.

Returns: Pointer to the retrieved subnet or NULL if not found.

Definition at line 18 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getSubnet4().

Here is the call graph for this function:

◆ getSubnet4() [2/2]

Subnet4Ptr isc::dhcp::ConfigBackendPoolDHCPv4::getSubnet4	(	const db::BackendSelector &	backend_selector,
		const db::ServerSelector &	server_selector,
		const SubnetID &	subnet_id ) const

virtual

Retrieves a single subnet by subnet identifier.

Parameters

backend_selector	Backend selector.
server_selector	Server selector.
subnet_id	Identifier of a subnet to be retrieved.

Returns: Pointer to the retrieved subnet or NULL if not found.

Definition at line 29 of file config_backend_pool_dhcp4.cc.

References isc::dhcp::ConfigBackendDHCPv4::getSubnet4().

Here is the call graph for this function:

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createUpdateClientClass4()

◆ createUpdateGlobalParameter4()

◆ createUpdateOption4() [1/4]

◆ createUpdateOption4() [2/4]

◆ createUpdateOption4() [3/4]

◆ createUpdateOption4() [4/4]

◆ createUpdateOptionDef4()

◆ createUpdateServer4()

◆ createUpdateSharedNetwork4()

◆ createUpdateSubnet4()

◆ deleteAllClientClasses4()

◆ deleteAllGlobalParameters4()

◆ deleteAllOptionDefs4()

◆ deleteAllServers4()

◆ deleteAllSharedNetworks4()

◆ deleteAllSubnets4()

◆ deleteClientClass4()

◆ deleteGlobalParameter4()

◆ deleteOption4() [1/4]

◆ deleteOption4() [2/4]

◆ deleteOption4() [3/4]

◆ deleteOption4() [4/4]

◆ deleteOptionDef4()

◆ deleteServer4()

◆ deleteSharedNetwork4()

◆ deleteSharedNetworkSubnets4()

◆ deleteSubnet4() [1/2]

◆ deleteSubnet4() [2/2]

◆ getAllClientClasses4()

◆ getAllGlobalParameters4()

◆ getAllOptionDefs4()

◆ getAllOptions4()

◆ getAllServers4()

◆ getAllSharedNetworks4()

◆ getAllSubnets4()

◆ getClientClass4()

◆ getGlobalParameter4()

◆ getModifiedClientClasses4()

◆ getModifiedGlobalParameters4()

◆ getModifiedOptionDefs4()

◆ getModifiedOptions4()

◆ getModifiedSharedNetworks4()

◆ getModifiedSubnets4()

◆ getOption4()

◆ getOptionDef4()

◆ getRecentAuditEntries()

◆ getServer4()

◆ getSharedNetwork4()

◆ getSharedNetworkSubnets4()

◆ getSubnet4() [1/2]

◆ getSubnet4() [2/2]