Kea 2.7.6
|
Represents global configuration for host reservations. More...
#include <cfg_host_operations.h>
Public Types | |
typedef std::list< Host::IdentifierType > | IdentifierTypes |
Type of the container holding ordered list of identifiers. | |
Public Member Functions | |
CfgHostOperations () | |
Constructor. | |
Public Member Functions inherited from isc::data::CfgToElement | |
virtual | ~CfgToElement () |
Destructor. | |
Factory functions for creating default configurations. | |
void | addIdentifierType (const std::string &identifier_name) |
Adds new identifier type to a collection of identifiers to be used by the server to search for host reservations. | |
const IdentifierTypes & | getIdentifierTypes () const |
Returns const reference to ordered collection of identifiers to be used by the server to search for host reservations. | |
void | clearIdentifierTypes () |
Removes existing identifier types. | |
virtual isc::data::ElementPtr | toElement () const |
Unparse a configuration object. | |
static CfgHostOperationsPtr | createConfig4 () |
Factory function for DHCPv4. | |
static CfgHostOperationsPtr | createConfig6 () |
Factory function for DHCPv6. | |
Represents global configuration for host reservations.
This class represents server configuration pertaining to host reservations.
Currently it only holds the ordered list of host identifiers to be used to search for reservations for a particular host. An administrator selects which identifiers the server should use and in which order to search for host reservations to optimize performance of the server.
Definition at line 43 of file cfg_host_operations.h.
typedef std::list<Host::IdentifierType> isc::dhcp::CfgHostOperations::IdentifierTypes |
Type of the container holding ordered list of identifiers.
Definition at line 47 of file cfg_host_operations.h.
isc::dhcp::CfgHostOperations::CfgHostOperations | ( | ) |
Constructor.
The default configuration:
Definition at line 19 of file cfg_host_operations.cc.
Referenced by createConfig4(), and createConfig6().
void isc::dhcp::CfgHostOperations::addIdentifierType | ( | const std::string & | identifier_name | ) |
Adds new identifier type to a collection of identifiers to be used by the server to search for host reservations.
identifier_name | Name of the identifier to be added. It must be one of the names supported by the Host::getIdentifierType function. |
Definition at line 46 of file cfg_host_operations.cc.
References isc::dhcp::Host::getIdentifierType(), and isc_throw.
void isc::dhcp::CfgHostOperations::clearIdentifierTypes | ( | ) |
Removes existing identifier types.
Definition at line 57 of file cfg_host_operations.cc.
|
static |
Factory function for DHCPv4.
Definition at line 24 of file cfg_host_operations.cc.
References CfgHostOperations().
|
static |
Factory function for DHCPv6.
Definition at line 36 of file cfg_host_operations.cc.
References CfgHostOperations().
|
inline |
Returns const reference to ordered collection of identifiers to be used by the server to search for host reservations.
Definition at line 74 of file cfg_host_operations.h.
|
virtual |
Unparse a configuration object.
Implements isc::data::CfgToElement.
Definition at line 62 of file cfg_host_operations.cc.
References isc::data::Element::create(), isc::data::Element::createList(), and isc::dhcp::Host::getIdentifierName().