Kea 1.5.0
isc::dhcp::ConfigBackendDHCPv4 Class Referenceabstract

Interface implemented by DHCPv4 configuration backends. More...

#include <config_backend_dhcp4.h>

+ Inheritance diagram for isc::dhcp::ConfigBackendDHCPv4:

Public Member Functions

virtual ~ConfigBackendDHCPv4 ()
 Virtual destructor.
 
virtual void createUpdateGlobalParameter4 (const db::ServerSelector &server_selector, const data::StampedValuePtr &value)=0
 Creates or updates global parameter.
 
virtual void createUpdateOption4 (const db::ServerSelector &selector, const std::string &shared_network_name, const OptionDescriptorPtr &option)=0
 Creates or updates shared network level option.
 
virtual void createUpdateOption4 (const db::ServerSelector &server_selector, const asiolink::IOAddress &pool_start_address, const asiolink::IOAddress &pool_end_address, const OptionDescriptorPtr &option)=0
 Creates or updates pool level option.
 
virtual void createUpdateOption4 (const db::ServerSelector &server_selector, const OptionDescriptorPtr &option)=0
 Creates or updates global option.
 
virtual void createUpdateOption4 (const db::ServerSelector &server_selector, const SubnetID &subnet_id, const OptionDescriptorPtr &option)=0
 Creates or updates subnet level option.
 
virtual void createUpdateOptionDef4 (const db::ServerSelector &server_selector, const OptionDefinitionPtr &option_def)=0
 Creates or updates an option definition.
 
virtual void createUpdateSharedNetwork4 (const db::ServerSelector &server_selector, const SharedNetwork4Ptr &shared_network)=0
 Creates or updates a shared network.
 
virtual void createUpdateSubnet4 (const db::ServerSelector &server_selector, const Subnet4Ptr &subnet)=0
 Creates or updates a subnet.
 
virtual uint64_t deleteAllGlobalParameters4 (const db::ServerSelector &server_selector)=0
 Deletes all global parameters.
 
virtual uint64_t deleteAllOptionDefs4 (const db::ServerSelector &server_selector)=0
 Deletes all option definitions.
 
virtual uint64_t deleteAllSharedNetworks4 (const db::ServerSelector &server_selector)=0
 Deletes all shared networks.
 
virtual uint64_t deleteAllSubnets4 (const db::ServerSelector &server_selector)=0
 Deletes all subnets.
 
virtual uint64_t deleteGlobalParameter4 (const db::ServerSelector &server_selector, const std::string &name)=0
 Deletes global parameter.
 
virtual uint64_t deleteOption4 (const db::ServerSelector &selector, const std::string &shared_network_name, const uint16_t code, const std::string &space)=0
 Deletes shared network level option.
 
virtual uint64_t deleteOption4 (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)=0
 Deletes pool level option.
 
virtual uint64_t deleteOption4 (const db::ServerSelector &server_selector, const SubnetID &subnet_id, const uint16_t code, const std::string &space)=0
 Deletes subnet level option.
 
virtual uint64_t deleteOption4 (const db::ServerSelector &server_selector, const uint16_t code, const std::string &space)=0
 Deletes global option.
 
virtual uint64_t deleteOptionDef4 (const db::ServerSelector &server_selector, const uint16_t code, const std::string &space)=0
 Deletes option definition.
 
virtual uint64_t deleteSharedNetwork4 (const db::ServerSelector &server_selector, const std::string &name)=0
 Deletes shared network by name.
 
virtual uint64_t deleteSubnet4 (const db::ServerSelector &server_selector, const std::string &subnet_prefix)=0
 Deletes subnet by prefix.
 
virtual uint64_t deleteSubnet4 (const db::ServerSelector &server_selector, const SubnetID &subnet_id)=0
 Deletes subnet by identifier.
 
virtual data::StampedValueCollection getAllGlobalParameters4 (const db::ServerSelector &selector) const =0
 
virtual OptionDefContainer getAllOptionDefs4 (const db::ServerSelector &server_selector) const =0
 Retrieves all option definitions.
 
virtual OptionContainer getAllOptions4 (const db::ServerSelector &server_selector) const =0
 Retrieves all global options.
 
virtual SharedNetwork4Collection getAllSharedNetworks4 (const db::ServerSelector &server_selector) const =0
 Retrieves all shared networks.
 
virtual Subnet4Collection getAllSubnets4 (const db::ServerSelector &server_selector) const =0
 Retrieves all subnets.
 
virtual data::StampedValuePtr getGlobalParameter4 (const db::ServerSelector &selector, const std::string &name) const =0
 Retrieves global parameter value.
 
virtual data::StampedValueCollection getModifiedGlobalParameters4 (const db::ServerSelector &selector, const boost::posix_time::ptime &modification_time) const =0
 Retrieves global parameters modified after specified time.
 
virtual OptionDefContainer getModifiedOptionDefs4 (const db::ServerSelector &server_selector, const boost::posix_time::ptime &modification_time) const =0
 Retrieves option definitions modified after specified time.
 
virtual OptionContainer getModifiedOptions4 (const db::ServerSelector &selector, const boost::posix_time::ptime &modification_time) const =0
 Retrieves option modified after specified time.
 
virtual SharedNetwork4Collection getModifiedSharedNetworks4 (const db::ServerSelector &server_selector, const boost::posix_time::ptime &modification_time) const =0
 Retrieves shared networks modified after specified time.
 
virtual Subnet4Collection getModifiedSubnets4 (const db::ServerSelector &server_selector, const boost::posix_time::ptime &modification_time) const =0
 Retrieves subnets modified after specified time.
 
virtual OptionDescriptorPtr getOption4 (const db::ServerSelector &server_selector, const uint16_t code, const std::string &space) const =0
 Retrieves single option by code and space.
 
virtual OptionDefinitionPtr getOptionDef4 (const db::ServerSelector &server_selector, const uint16_t code, const std::string &space) const =0
 Retrieves single option definition by code and space.
 
virtual SharedNetwork4Ptr getSharedNetwork4 (const db::ServerSelector &server_selector, const std::string &name) const =0
 Retrieves shared network by name.
 
virtual Subnet4Ptr getSubnet4 (const db::ServerSelector &server_selector, const std::string &subnet_prefix) const =0
 Retrieves a single subnet by subnet_prefix.
 
virtual Subnet4Ptr getSubnet4 (const db::ServerSelector &server_selector, const SubnetID &subnet_id) const =0
 Retrieves a single subnet by subnet identifier.
 
- Public Member Functions inherited from isc::cb::BaseConfigBackend
virtual ~BaseConfigBackend ()
 Virtual destructor.
 
virtual std::string getHost () const =0
 Returns backend host.
 
virtual uint16_t getPort () const =0
 Returns backend port number.
 
virtual std::string getType () const =0
 Returns backend type in the textual format.
 

Detailed Description

Interface implemented by DHCPv4 configuration backends.

Definition at line 26 of file config_backend_dhcp4.h.

Constructor & Destructor Documentation

◆ ~ConfigBackendDHCPv4()

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

Virtual destructor.

Definition at line 30 of file config_backend_dhcp4.h.

Member Function Documentation

◆ createUpdateGlobalParameter4()

virtual void isc::dhcp::ConfigBackendDHCPv4::createUpdateGlobalParameter4 ( const db::ServerSelector server_selector,
const data::StampedValuePtr value 
)
pure virtual

Creates or updates global parameter.

Parameters
server_selectorServer selector.
valueValue of the global parameter.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateGlobalParameter4().

◆ createUpdateOption4() [1/4]

virtual void isc::dhcp::ConfigBackendDHCPv4::createUpdateOption4 ( const db::ServerSelector selector,
const std::string &  shared_network_name,
const OptionDescriptorPtr option 
)
pure virtual

Creates or updates shared network level option.

Parameters
selectorServer selector.
shared_network_nameName of a shared network to which option belongs.
optionOption to be added or updated.

◆ createUpdateOption4() [2/4]

virtual void isc::dhcp::ConfigBackendDHCPv4::createUpdateOption4 ( const db::ServerSelector server_selector,
const asiolink::IOAddress pool_start_address,
const asiolink::IOAddress pool_end_address,
const OptionDescriptorPtr option 
)
pure virtual

Creates or updates pool level option.

Parameters
server_selectorServer selector.
pool_start_addressLower bound address of the pool to which the option belongs.
pool_end_addressUpper bound address of the pool to which the option belongs.
optionOption to be added or updated.

◆ createUpdateOption4() [3/4]

virtual void isc::dhcp::ConfigBackendDHCPv4::createUpdateOption4 ( const db::ServerSelector server_selector,
const OptionDescriptorPtr option 
)
pure virtual

Creates or updates global option.

Parameters
server_selectorServer selector.
optionOption to be added or updated.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateOption4().

◆ createUpdateOption4() [4/4]

virtual void isc::dhcp::ConfigBackendDHCPv4::createUpdateOption4 ( const db::ServerSelector server_selector,
const SubnetID subnet_id,
const OptionDescriptorPtr option 
)
pure virtual

Creates or updates subnet level option.

Parameters
server_selectorServer selector.
subnet_idIdentifier of a subnet to which option belongs.
optionOption to be added or updated.

◆ createUpdateOptionDef4()

virtual void isc::dhcp::ConfigBackendDHCPv4::createUpdateOptionDef4 ( const db::ServerSelector server_selector,
const OptionDefinitionPtr option_def 
)
pure virtual

Creates or updates an option definition.

Parameters
server_selectorServer selector.
option_defOption definition to be added or updated.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateOptionDef4().

◆ createUpdateSharedNetwork4()

virtual void isc::dhcp::ConfigBackendDHCPv4::createUpdateSharedNetwork4 ( const db::ServerSelector server_selector,
const SharedNetwork4Ptr shared_network 
)
pure virtual

Creates or updates a shared network.

Parameters
server_selectorServer selector.
shared_networkShared network to be added or updated.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateSharedNetwork4().

◆ createUpdateSubnet4()

virtual void isc::dhcp::ConfigBackendDHCPv4::createUpdateSubnet4 ( const db::ServerSelector server_selector,
const Subnet4Ptr subnet 
)
pure virtual

Creates or updates a subnet.

Parameters
server_selectorServer selector.
subnetSubnet to be added or updated.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::createUpdateSubnet4().

◆ deleteAllGlobalParameters4()

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteAllGlobalParameters4 ( const db::ServerSelector server_selector)
pure virtual

Deletes all global parameters.

Parameters
server_selectorServer selector.
Returns
Number of deleted global parameters.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::deleteAllGlobalParameters4().

◆ deleteAllOptionDefs4()

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteAllOptionDefs4 ( const db::ServerSelector server_selector)
pure virtual

Deletes all option definitions.

Parameters
server_selectorServer selector.
Returns
Number of deleted option definitions.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::deleteAllOptionDefs4().

◆ deleteAllSharedNetworks4()

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteAllSharedNetworks4 ( const db::ServerSelector server_selector)
pure virtual

Deletes all shared networks.

Parameters
server_selectorServer selector.
Returns
Number of deleted shared networks.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::deleteAllSharedNetworks4().

◆ deleteAllSubnets4()

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteAllSubnets4 ( const db::ServerSelector server_selector)
pure virtual

Deletes all subnets.

Parameters
server_selectorServer selector.
Returns
Number of deleted subnets.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::deleteAllSubnets4().

◆ deleteGlobalParameter4()

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteGlobalParameter4 ( const db::ServerSelector server_selector,
const std::string &  name 
)
pure virtual

Deletes global parameter.

Parameters
server_selectorServer selector.
nameName of the global parameter to be deleted.
Returns
Number of deleted global parameters.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::deleteGlobalParameter4().

◆ deleteOption4() [1/4]

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteOption4 ( const db::ServerSelector selector,
const std::string &  shared_network_name,
const uint16_t  code,
const std::string &  space 
)
pure virtual

Deletes shared network level option.

Parameters
selectorServer selector.
shared_network_nameName of the shared network which option belongs to.
codeCode of the option to be deleted.
spaceOption space of the option to be deleted.

◆ deleteOption4() [2/4]

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteOption4 ( 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 
)
pure virtual

Deletes pool level option.

Parameters
server_selectorServer selector.
pool_start_addressLower bound address of the pool to which deleted option belongs.
pool_end_addressUpper bound address of the pool to which the deleted option belongs.
codeCode of the deleted option.
spaceOption space of the deleted option.
Returns
Number of deleted options.

◆ deleteOption4() [3/4]

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteOption4 ( const db::ServerSelector server_selector,
const SubnetID subnet_id,
const uint16_t  code,
const std::string &  space 
)
pure virtual

Deletes subnet level option.

Parameters
server_selectorServer selector.
subnet_idIdentifier of the subnet to which deleted option belongs.
codeCode of the deleted option.
spaceOption space of the deleted option.
Returns
Number of deleted options.

◆ deleteOption4() [4/4]

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteOption4 ( const db::ServerSelector server_selector,
const uint16_t  code,
const std::string &  space 
)
pure virtual

Deletes global option.

Parameters
server_selectorServer selector.
codeCode of the option to be deleted.
spaceOption space of the option to be deleted.
Returns
Number of deleted options.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::deleteOption4().

◆ deleteOptionDef4()

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteOptionDef4 ( const db::ServerSelector server_selector,
const uint16_t  code,
const std::string &  space 
)
pure virtual

Deletes option definition.

Parameters
server_selectorServer selector.
codeCode of the option to be deleted.
spaceOption space of the option to be deleted.
Returns
Number of deleted option definitions.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::deleteOptionDef4().

◆ deleteSharedNetwork4()

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteSharedNetwork4 ( const db::ServerSelector server_selector,
const std::string &  name 
)
pure virtual

Deletes shared network by name.

Parameters
server_selectorServer selector.
nameName of the shared network to be deleted.
Returns
Number of deleted shared networks..

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::deleteSharedNetwork4().

◆ deleteSubnet4() [1/2]

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteSubnet4 ( const db::ServerSelector server_selector,
const std::string &  subnet_prefix 
)
pure virtual

Deletes subnet by prefix.

Parameters
server_selectorServer selector.
subnet_prefixPrefix of the subnet to be deleted.
Returns
Number of deleted subnets.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::deleteSubnet4().

◆ deleteSubnet4() [2/2]

virtual uint64_t isc::dhcp::ConfigBackendDHCPv4::deleteSubnet4 ( const db::ServerSelector server_selector,
const SubnetID subnet_id 
)
pure virtual

Deletes subnet by identifier.

Parameters
server_selectorServer selector.
subnet_idIdentifier of the subnet to be deleted.
Returns
Number of deleted subnets.

◆ getAllGlobalParameters4()

virtual data::StampedValueCollection isc::dhcp::ConfigBackendDHCPv4::getAllGlobalParameters4 ( const db::ServerSelector selector) const
pure virtual
Returns
Collection of global parameters.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getAllGlobalParameters4().

◆ getAllOptionDefs4()

virtual OptionDefContainer isc::dhcp::ConfigBackendDHCPv4::getAllOptionDefs4 ( const db::ServerSelector server_selector) const
pure virtual

Retrieves all option definitions.

Parameters
server_selectorServer selector.
Returns
Collection of option definitions or empty collection if no option definition found.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getAllOptionDefs4().

◆ getAllOptions4()

virtual OptionContainer isc::dhcp::ConfigBackendDHCPv4::getAllOptions4 ( const db::ServerSelector server_selector) const
pure virtual

Retrieves all global options.

Parameters
server_selectorServer selector.
Returns
Collection of global options or empty collection if no option found.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getAllOptions4().

◆ getAllSharedNetworks4()

virtual SharedNetwork4Collection isc::dhcp::ConfigBackendDHCPv4::getAllSharedNetworks4 ( const db::ServerSelector server_selector) const
pure virtual

Retrieves all shared networks.

Parameters
server_selectorServer selector.
Returns
Collection of shared network or empty collection if no shared network found.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getAllSharedNetworks4().

◆ getAllSubnets4()

virtual Subnet4Collection isc::dhcp::ConfigBackendDHCPv4::getAllSubnets4 ( const db::ServerSelector server_selector) const
pure virtual

Retrieves all subnets.

Parameters
server_selectorServer selector.
Returns
Collection of subnets or empty collection if no subnet found.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getAllSubnets4().

◆ getGlobalParameter4()

virtual data::StampedValuePtr isc::dhcp::ConfigBackendDHCPv4::getGlobalParameter4 ( const db::ServerSelector selector,
const std::string &  name 
) const
pure virtual

Retrieves global parameter value.

Parameters
selectorServer selector.
nameName of the global parameter to be retrieved.
Returns
Value of the global parameter or null if parameter doesn't exist.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getGlobalParameter4().

◆ getModifiedGlobalParameters4()

virtual data::StampedValueCollection isc::dhcp::ConfigBackendDHCPv4::getModifiedGlobalParameters4 ( const db::ServerSelector selector,
const boost::posix_time::ptime &  modification_time 
) const
pure virtual

Retrieves global parameters modified after specified time.

Parameters
selectorServer selector.
modification_timeModification time.
Returns
Collection of modified global parameters.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getModifiedGlobalParameters4().

◆ getModifiedOptionDefs4()

virtual OptionDefContainer isc::dhcp::ConfigBackendDHCPv4::getModifiedOptionDefs4 ( const db::ServerSelector server_selector,
const boost::posix_time::ptime &  modification_time 
) const
pure virtual

Retrieves option definitions modified after specified time.

Parameters
server_selectorServer selector.
modification_timeLower bound option definition modification time.
Returns
Collection of option definitions or empty collection if no option definition found.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getModifiedOptionDefs4().

◆ getModifiedOptions4()

virtual OptionContainer isc::dhcp::ConfigBackendDHCPv4::getModifiedOptions4 ( const db::ServerSelector selector,
const boost::posix_time::ptime &  modification_time 
) const
pure virtual

Retrieves option modified after specified time.

Parameters
selectorServer selector.
modification_timeLower bound option modification time.
Returns
Collection of global options or empty collection if no option found.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getModifiedOptions4().

◆ getModifiedSharedNetworks4()

virtual SharedNetwork4Collection isc::dhcp::ConfigBackendDHCPv4::getModifiedSharedNetworks4 ( const db::ServerSelector server_selector,
const boost::posix_time::ptime &  modification_time 
) const
pure virtual

Retrieves shared networks modified after specified time.

Parameters
server_selectorServer selector.
modification_timeLower bound shared network modification time.
Returns
Collection of shared network or empty collection if no shared network found.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getModifiedSharedNetworks4().

◆ getModifiedSubnets4()

virtual Subnet4Collection isc::dhcp::ConfigBackendDHCPv4::getModifiedSubnets4 ( const db::ServerSelector server_selector,
const boost::posix_time::ptime &  modification_time 
) const
pure virtual

Retrieves subnets modified after specified time.

Parameters
server_selectorServer selector.
modification_timeLower bound subnet modification time.
Returns
Collection of subnets or empty collection if no subnet found.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getModifiedSubnets4().

◆ getOption4()

virtual OptionDescriptorPtr isc::dhcp::ConfigBackendDHCPv4::getOption4 ( const db::ServerSelector server_selector,
const uint16_t  code,
const std::string &  space 
) const
pure virtual

Retrieves single option by code and space.

Parameters
server_selectorServer selector.
codeOption code.
spaceOption space.
Returns
Pointer to the retrieved option descriptor or null if no option was found.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getOption4().

◆ getOptionDef4()

virtual OptionDefinitionPtr isc::dhcp::ConfigBackendDHCPv4::getOptionDef4 ( const db::ServerSelector server_selector,
const uint16_t  code,
const std::string &  space 
) const
pure virtual

Retrieves single option definition by code and space.

Parameters
server_selectorServer selector.
codeCode of the option to be retrieved.
spaceOption space of the option to be retrieved.
Returns
Pointer to the option definition or NULL if not found.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getOptionDef4().

◆ getSharedNetwork4()

virtual SharedNetwork4Ptr isc::dhcp::ConfigBackendDHCPv4::getSharedNetwork4 ( const db::ServerSelector server_selector,
const std::string &  name 
) const
pure virtual

Retrieves shared network by name.

Parameters
server_selectorServer selector.
nameName of the shared network to be retrieved.
Returns
Pointer to the shared network or NULL if not found.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getSharedNetwork4().

◆ getSubnet4() [1/2]

virtual Subnet4Ptr isc::dhcp::ConfigBackendDHCPv4::getSubnet4 ( const db::ServerSelector server_selector,
const std::string &  subnet_prefix 
) const
pure virtual

Retrieves a single subnet by subnet_prefix.

Parameters
server_selectorServer selector.
subnet_prefixPrefix of the subnet to be retrieved.
Returns
Pointer to the retrieved subnet or NULL if not found.

Referenced by isc::dhcp::ConfigBackendPoolDHCPv4::getSubnet4().

◆ getSubnet4() [2/2]

virtual Subnet4Ptr isc::dhcp::ConfigBackendDHCPv4::getSubnet4 ( const db::ServerSelector server_selector,
const SubnetID subnet_id 
) const
pure virtual

Retrieves a single subnet by subnet identifier.

Parameters
server_selectorServer selector.
subnet_idIdentifier of a subnet to be retrieved.
Returns
Pointer to the retrieved subnet or NULL if not found.

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