![]() |
Kea
2.3.5-git
|
Common interface representing a network to which the DHCP clients are connected. More...
#include <network.h>
Classes | |
class | RelayInfo |
Holds optional information about relay. More... | |
Public Types | |
enum | Inheritance { Inheritance::NONE, Inheritance::PARENT_NETWORK, Inheritance::GLOBAL, Inheritance::ALL } |
Inheritance "mode" used when fetching an optional Network parameter. More... | |
typedef boost::shared_ptr< Network::RelayInfo > | RelayInfoPtr |
Pointer to the RelayInfo structure. More... | |
Public Member Functions | |
Network () | |
Constructor. More... | |
virtual | ~Network () |
Virtual destructor. More... | |
void | addRelayAddress (const asiolink::IOAddress &addr) |
Adds an address to the list addresses in the network's relay info. More... | |
void | allowClientClass (const isc::dhcp::ClientClass &class_name) |
Sets the supported class to class class_name. More... | |
virtual bool | clientSupported (const isc::dhcp::ClientClasses &client_classes) const |
Checks whether this network supports client that belongs to specified classes. More... | |
util::Optional< std::string > | getAllocatorType (const Inheritance &inheritance=Inheritance::ALL) const |
Returns allocator type. More... | |
util::Optional< uint32_t > | getCacheMaxAge (const Inheritance &inheritance=Inheritance::ALL) const |
Returns value in seconds to use as cache maximum age. More... | |
util::Optional< double > | getCacheThreshold (const Inheritance &inheritance=Inheritance::ALL) const |
Returns percentage to use as cache threshold. More... | |
util::Optional< bool > | getCalculateTeeTimes (const Inheritance &inheritance=Inheritance::ALL) const |
Returns whether or not T1/T2 calculation is enabled. More... | |
CfgOptionPtr | getCfgOption () |
Returns pointer to the option data configuration for this network. More... | |
ConstCfgOptionPtr | getCfgOption () const |
Returns const pointer to the option data configuration for this network. More... | |
util::Optional< ClientClass > | getClientClass (const Inheritance &inheritance=Inheritance::ALL) const |
returns the client class More... | |
util::Optional< std::string > | getDdnsGeneratedPrefix (const Inheritance &inheritance=Inheritance::ALL) const |
Returns ddns-generated-prefix. More... | |
util::Optional< bool > | getDdnsOverrideClientUpdate (const Inheritance &inheritance=Inheritance::ALL) const |
Returns ddns-override-client-update. More... | |
util::Optional< bool > | getDdnsOverrideNoUpdate (const Inheritance &inheritance=Inheritance::ALL) const |
Returns ddns-override-no-update. More... | |
util::Optional< std::string > | getDdnsQualifyingSuffix (const Inheritance &inheritance=Inheritance::ALL) const |
Returns ddns-qualifying-suffix. More... | |
util::Optional< D2ClientConfig::ReplaceClientNameMode > | getDdnsReplaceClientNameMode (const Inheritance &inheritance=Inheritance::ALL) const |
Returns ddns-replace-client-name-mode. More... | |
util::Optional< bool > | getDdnsSendUpdates (const Inheritance &inheritance=Inheritance::ALL) const |
Returns ddns-send-updates. More... | |
util::Optional< bool > | getDdnsUpdateOnRenew (const Inheritance &inheritance=Inheritance::ALL) const |
Returns ddns-update-on-renew. More... | |
util::Optional< bool > | getDdnsUseConflictResolution (const Inheritance &inheritance=Inheritance::ALL) const |
Returns ddns-use-conflict-resolution. More... | |
util::Optional< std::string > | getHostnameCharReplacement (const Inheritance &inheritance=Inheritance::ALL) const |
Return the invalid char replacement used to sanitize client hostnames. More... | |
util::Optional< std::string > | getHostnameCharSet (const Inheritance &inheritance=Inheritance::ALL) const |
Return the char set regexp used to sanitize client hostnames. More... | |
util::Optional< std::string > | getIface (const Inheritance &inheritance=Inheritance::ALL) const |
Returns name of the local interface for which this network is selected. More... | |
const IOAddressList & | getRelayAddresses () const |
Returns the list of relay addresses from the network's relay info. More... | |
const RelayInfo & | getRelayInfo () const |
Returns const reference to relay information. More... | |
const ClientClasses & | getRequiredClasses () const |
Returns classes which are required to be evaluated. More... | |
util::Optional< bool > | getReservationsGlobal (const Inheritance &inheritance=Inheritance::ALL) const |
Returns whether global reservations should be fetched. More... | |
util::Optional< bool > | getReservationsInSubnet (const Inheritance &inheritance=Inheritance::ALL) const |
Returns whether subnet reservations should be fetched. More... | |
util::Optional< bool > | getReservationsOutOfPool (const Inheritance &inheritance=Inheritance::ALL) const |
Returns whether only out-of-pool reservations are allowed. More... | |
util::Optional< bool > | getStoreExtendedInfo (const Inheritance &inheritance=Inheritance::ALL) const |
Returns store-extended-info. More... | |
isc::util::Triplet< uint32_t > | getT1 (const Inheritance &inheritance=Inheritance::ALL) const |
Returns T1 (renew timer), expressed in seconds. More... | |
util::Optional< double > | getT1Percent (const Inheritance &inheritance=Inheritance::ALL) const |
Returns percentage to use when calculating the T1 (renew timer). More... | |
isc::util::Triplet< uint32_t > | getT2 (const Inheritance &inheritance=Inheritance::ALL) const |
Returns T2 (rebind timer), expressed in seconds. More... | |
util::Optional< double > | getT2Percent (const Inheritance &inheritance=Inheritance::ALL) const |
Returns percentage to use when calculating the T2 (rebind timer). More... | |
isc::util::Triplet< uint32_t > | getValid (const Inheritance &inheritance=Inheritance::ALL) const |
Return valid-lifetime for addresses in that prefix. More... | |
bool | hasFetchGlobalsFn () const |
Checks if the network is associated with a function used to fetch globally configured parameters. More... | |
bool | hasRelayAddress (const asiolink::IOAddress &address) const |
Tests if the network's relay info contains the given address. More... | |
bool | hasRelays () const |
Indicates if network's relay info has relay addresses. More... | |
void | requireClientClass (const isc::dhcp::ClientClass &class_name) |
Adds class class_name to classes required to be evaluated. More... | |
void | setAllocatorType (const util::Optional< std::string > &allocator_type) |
Sets new allocator type. More... | |
void | setCacheMaxAge (const util::Optional< uint32_t > &cache_max_age) |
Sets cache max for a network. More... | |
void | setCacheThreshold (const util::Optional< double > &cache_threshold) |
Sets cache threshold for a network. More... | |
void | setCalculateTeeTimes (const util::Optional< bool > &calculate_tee_times) |
Sets whether or not T1/T2 calculation is enabled. More... | |
void | setDdnsGeneratedPrefix (const util::Optional< std::string > &ddns_generated_prefix) |
Sets new ddns-generated-prefix. More... | |
void | setDdnsOverrideClientUpdate (const util::Optional< bool > &ddns_override_client_update) |
Sets new ddns-override-client-update. More... | |
void | setDdnsOverrideNoUpdate (const util::Optional< bool > &ddns_override_no_update) |
Sets new ddns-override-no-update. More... | |
void | setDdnsQualifyingSuffix (const util::Optional< std::string > &ddns_qualifying_suffix) |
Sets new ddns-qualifying-suffix. More... | |
void | setDdnsReplaceClientNameMode (const util::Optional< D2ClientConfig::ReplaceClientNameMode > &ddns_replace_client_name_mode) |
Sets new ddns-replace-client-name-mode. More... | |
void | setDdnsSendUpdates (const util::Optional< bool > &ddns_send_updates) |
Sets new ddns-send-updates. More... | |
void | setDdnsUpdateOnRenew (const util::Optional< bool > &ddns_update_on_renew) |
Sets new ddns-update-on-renew. More... | |
void | setDdnsUseConflictResolution (const util::Optional< bool > &ddns_use_conflict_resolution) |
Sets new ddns-use-conflict-resolution. More... | |
void | setFetchGlobalsFn (FetchNetworkGlobalsFn fetch_globals_fn) |
Sets the optional callback function used to fetch globally configured parameters. More... | |
void | setHostnameCharReplacement (const util::Optional< std::string > &hostname_char_replacement) |
Sets new hostname-char-replacement. More... | |
void | setHostnameCharSet (const util::Optional< std::string > &hostname_char_set) |
Sets new hostname-char-set. More... | |
void | setIface (const util::Optional< std::string > &iface_name) |
Sets local name of the interface for which this network is selected. More... | |
void | setRelayInfo (const RelayInfo &relay) |
Sets information about relay. More... | |
void | setReservationsGlobal (const util::Optional< bool > &reservations_global) |
Sets whether global reservations should be fetched. More... | |
void | setReservationsInSubnet (const util::Optional< bool > &reservations_in_subnet) |
Sets whether subnet reservations should be fetched. More... | |
void | setReservationsOutOfPool (const util::Optional< bool > &reservations_out_of_pool) |
Sets whether only out-of-pool reservations are allowed. More... | |
void | setStoreExtendedInfo (const util::Optional< bool > &store_extended_info) |
Sets new store-extended-info. More... | |
void | setT1 (const isc::util::Triplet< uint32_t > &t1) |
Sets new renew timer for a network. More... | |
void | setT1Percent (const util::Optional< double > &t1_percent) |
Sets new percentage for calculating T1 (renew timer). More... | |
void | setT2 (const isc::util::Triplet< uint32_t > &t2) |
Sets new rebind timer for a network. More... | |
void | setT2Percent (const util::Optional< double > &t2_percent) |
Sets new percentage for calculating T2 (rebind timer). More... | |
void | setValid (const isc::util::Triplet< uint32_t > &valid) |
Sets new valid lifetime for a network. More... | |
virtual data::ElementPtr | toElement () const |
Unparses network object. More... | |
![]() | |
StampedElement () | |
Constructor. More... | |
void | delServerTag (const std::string &server_tag) |
Deletes server tag. More... | |
isc::data::ElementPtr | getMetadata () const |
Returns an object representing metadata to be returned with objects from the configuration backend. More... | |
std::set< ServerTag > | getServerTags () const |
Returns server tags. More... | |
bool | hasAllServerTag () const |
Checks if the element has 'all' server tag. More... | |
bool | hasServerTag (const ServerTag &server_tag) const |
Checks if the element has the given server tag. More... | |
void | setServerTag (const std::string &server_tag) |
Adds new server tag. More... | |
![]() | |
BaseStampedElement () | |
Constructor. More... | |
uint64_t | getId () const |
Returns element's database identifier. More... | |
boost::posix_time::ptime | getModificationTime () const |
Returns timestamp. More... | |
void | setId (const uint64_t id) |
Sets element's database identifier. More... | |
void | setModificationTime (const boost::posix_time::ptime ×tamp) |
Sets timestamp to the explicitly provided value. More... | |
void | updateModificationTime () |
Sets timestamp to the current time. More... | |
![]() | |
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... | |
![]() | |
virtual | ~CfgToElement () |
Destructor. More... | |
Protected Member Functions | |
FetchNetworkGlobalsFn | getFetchGlobalsFn () const |
Gets the optional callback function used to fetch globally configured parameters. More... | |
template<typename ReturnType > | |
ReturnType | getGlobalProperty (ReturnType property, const int global_index, const int min_index=-1, const int max_index=-1) const |
Returns a value of global configuration parameter with a given index. More... | |
template<typename NumType > | |
isc::util::Triplet< NumType > | getGlobalProperty (isc::util::Triplet< NumType > property, const int global_index, const int min_index=-1, const int max_index=-1) const |
The getGlobalProperty specialization for isc::util::Triplet<T>. More... | |
util::Optional< asiolink::IOAddress > | getGlobalProperty (util::Optional< asiolink::IOAddress > property, const int global_index, const int min_index=-1, const int max_index=-1) const |
The getGlobalProperty specialization for Optional<IOAddress>. More... | |
template<typename BaseType > | |
OptionPtr | getOptionProperty (OptionPtr(BaseType::*MethodPointer)(const Inheritance &inheritance) const, OptionPtr property, const Inheritance &inheritance) const |
Returns option pointer associated with a network using inheritance. More... | |
template<typename BaseType , typename ReturnType > | |
ReturnType | getProperty (ReturnType(BaseType::*MethodPointer)(const Inheritance &) const, ReturnType property, const Inheritance &inheritance, const int global_index=-1, const int min_index=-1, const int max_index=-1) const |
Returns a value associated with a network using inheritance. More... | |
Protected Attributes | |
util::Optional< std::string > | allocator_type_ |
Allocator used for IP address allocations. More... | |
util::Optional< uint32_t > | cache_max_age_ |
Value in seconds to use as cache maximal age. More... | |
util::Optional< double > | cache_threshold_ |
Percentage of the lease lifetime to use as cache threshold. More... | |
util::Optional< bool > | calculate_tee_times_ |
Enables calculation of T1 and T2 timers. More... | |
CfgOptionPtr | cfg_option_ |
Pointer to the option data configuration for this subnet. More... | |
util::Optional< ClientClass > | client_class_ |
Optional definition of a client class. More... | |
util::Optional< std::string > | ddns_generated_prefix_ |
Prefix Kea should use when generating domain-names. More... | |
util::Optional< bool > | ddns_override_client_update_ |
Should Kea perform updates, even if client requested delegation. More... | |
util::Optional< bool > | ddns_override_no_update_ |
Should Kea perform updates, even if client requested no updates. More... | |
util::Optional< std::string > | ddns_qualifying_suffix_ |
Suffix Kea should use when to qualify partial domain-names. More... | |
util::Optional< D2ClientConfig::ReplaceClientNameMode > | ddns_replace_client_name_mode_ |
How Kea should handle the domain-name supplied by the client. More... | |
util::Optional< bool > | ddns_send_updates_ |
Should Kea perform DNS updates. More... | |
util::Optional< bool > | ddns_update_on_renew_ |
Should Kea perform updates when leases are extended. More... | |
util::Optional< bool > | ddns_use_conflict_resolution_ |
Used to to tell kea-dhcp-ddns whether or not to use conflict resolution. More... | |
FetchNetworkGlobalsFn | fetch_globals_fn_ |
Pointer to the optional callback used to fetch globally configured parameters inherited to the Network object. More... | |
util::Optional< std::string > | hostname_char_replacement_ |
A string to replace invalid characters when scrubbing hostnames. More... | |
util::Optional< std::string > | hostname_char_set_ |
Regular expression describing invalid characters for client hostnames. More... | |
util::Optional< std::string > | iface_name_ |
Holds interface name for which this network is selected. More... | |
WeakNetworkPtr | parent_network_ |
Pointer to another network that this network belongs to. More... | |
RelayInfo | relay_ |
Relay information. More... | |
ClientClasses | required_classes_ |
Required classes. More... | |
util::Optional< bool > | reservations_global_ |
Enables global reservations. More... | |
util::Optional< bool > | reservations_in_subnet_ |
Enables subnet reservations. More... | |
util::Optional< bool > | reservations_out_of_pool_ |
Enables out-of-pool reservations optimization. More... | |
util::Optional< bool > | store_extended_info_ |
Should Kea store additional client query data (e.g. More... | |
isc::util::Triplet< uint32_t > | t1_ |
a isc::util::Triplet (min/default/max) holding allowed renew timer values More... | |
util::Optional< double > | t1_percent_ |
Percentage of the lease lifetime to use when calculating T1 timer. More... | |
isc::util::Triplet< uint32_t > | t2_ |
a isc::util::Triplet (min/default/max) holding allowed rebind timer values More... | |
util::Optional< double > | t2_percent_ |
Percentage of the lease lifetime to use when calculating T2 timer. More... | |
isc::util::Triplet< uint32_t > | valid_ |
a isc::util::Triplet (min/default/max) holding allowed valid lifetime values More... | |
![]() | |
uint64_t | id_ |
Database identifier of the configuration element. More... | |
boost::posix_time::ptime | timestamp_ |
Holds timestamp value. More... | |
![]() | |
data::ConstElementPtr | user_context_ |
Pointer to the user context (may be NULL) More... | |
Additional Inherited Members | |
![]() | |
static data::ElementPtr | toElement (data::ConstElementPtr map) |
Copy an Element map. More... | |
Common interface representing a network to which the DHCP clients are connected.
The most common type of network, in Kea's terminology, is a subnet. The Subnet derives from this class. Another types of objects implementing this interface are SharedNetwork4 and SharedNetwork6 objects. They group multiple subnets together to provide means for extending available address pools (a single client may obtain IP address from any of the pools belonging to subnets in the shared network), or for selecting a subnet on a given link, depending on the class of the client (e.g. cable network case: different subnet is selected for cable modems, different one for routers).
The subnets and shared networks share many data structures, e.g. DHCP options, local interface name, address manipulation methods. Both subnets and shared networks derive from this class to provide the common functionality.
The DHCP server configuration is complex because many parameters may be specified at different levels of hierarchy. The lower level values, e.g. subnet specific values, take precedence over upper level values, e.g. shared network specific ones. For historical reasons, the DHCP servers expect that the appropriate values are inherited from the upper configuration levels to the lower configuration levels upon the reconfiguration. For example: if a user didn't specify valid-lifetime for a subnet, calling Subnet4::getValid()
should result in returning a global value of valid-lifetime. In the early Kea days it was achieved by the configuration parsers which would explicitly assign the global valid lifetime to the Subnet4
instances for which the subnet specific value was not provided. This approach has a major benefit that it is fast. However, it makes the subnets tightly dependent on the global values (and shared network specific values). Modification of the global value must result in modification of this value in all subnets for which there is no explicit value provided. This issue became a serious road block during the implementation of the Configuration Backend.
The Network
object has been modified to address the problem of inheritance of global, shared network specific and subnet specific parameters in a generic way, at the same time minimizing the need to change the existing server logic.
The Network
object now holds the pointer to the "parent" Network
object. Thus subnets which belong to a shared network will have that shared network as its parent. Stand-alone subnets, will have no parent.
The general idea is that the accessor functions of the network will first check if the accessed value is specified or not (that is handled by util::Optional
object). If the value is specified it is returned. Otherwise, the object will check if there is a parent object it belongs to and will call the appropriate method of that object. If the value is present it is returned. Otherwise the global value is returned.
Accessing global values from the Network
object is troublesome. There is no uniform way to access those values. For example, the given network may be in a staging or current configuration and it really has no means to know in which of the two it belongs. In fact, an attempt to pass the pointer to the SrvConfig
object would cause a circular dependency between the Network
and the SrvConfig
. Even if it was possible and the Network
had access to the specific SrvConfig
instance, it doesn't handle the cases when the SrvConfig
instance was modified.
To deal with the problem of accessing the global parameters in a flexible manner, we elected to use an optional callback function which can be associated with the Network
object. This callback implements the logic to retrieve global parameters and return them in a well known form, so as the Network
accessors can use them.
typedef boost::shared_ptr<Network::RelayInfo> isc::dhcp::Network::RelayInfoPtr |
|
strong |
Inheritance "mode" used when fetching an optional Network
parameter.
The following modes are currently supported:
Enumerator | |
---|---|
NONE | |
PARENT_NETWORK | |
GLOBAL | |
ALL |
|
inlinevirtual |
void isc::dhcp::Network::addRelayAddress | ( | const asiolink::IOAddress & | addr | ) |
Adds an address to the list addresses in the network's relay info.
addr | address of the relay |
BadValue | if the address is already in the list |
Definition at line 49 of file network.cc.
void isc::dhcp::Network::allowClientClass | ( | const isc::dhcp::ClientClass & | class_name | ) |
Sets the supported class to class class_name.
class_name | client class to be supported by this network |
Definition at line 80 of file network.cc.
|
virtual |
Checks whether this network supports client that belongs to specified classes.
This method checks whether a client that belongs to given classes can use this network. For example, if this class is reserved for client class "foo" and the client belongs to classes "foo", "bar" and "baz", it is supported. On the other hand, client belonging to classes "foobar" and "zyxxy" is not supported.
client_classes | list of all classes the client belongs to |
Reimplemented in isc::dhcp::Subnet6, and isc::dhcp::Subnet4.
Definition at line 69 of file network.cc.
References isc::dhcp::ClientClasses::contains().
Referenced by isc::dhcp::Subnet4::clientSupported(), and isc::dhcp::Subnet6::clientSupported().
|
inline |
Returns allocator type.
inheritance | inheritance mode to be used. |
Definition at line 786 of file network.h.
References isc::dhcp::CfgGlobals::ALLOCATOR.
|
inline |
Returns value in seconds to use as cache maximum age.
inheritance | inheritance mode to be used. |
Definition at line 735 of file network.h.
References isc::dhcp::CfgGlobals::CACHE_MAX_AGE.
|
inline |
Returns percentage to use as cache threshold.
inheritance | inheritance mode to be used. |
Definition at line 718 of file network.h.
References isc::dhcp::CfgGlobals::CACHE_THRESHOLD.
|
inline |
Returns whether or not T1/T2 calculation is enabled.
inheritance | inheritance mode to be used. |
Definition at line 488 of file network.h.
References isc::dhcp::CfgGlobals::CALCULATE_TEE_TIMES.
|
inline |
|
inline |
|
inline |
returns the client class
inheritance | inheritance mode to be used. |
|
inline |
Returns ddns-generated-prefix.
inheritance | inheritance mode to be used. |
Definition at line 636 of file network.h.
References isc::dhcp::CfgGlobals::DDNS_GENERATED_PREFIX.
|
inline |
Returns ddns-override-client-update.
inheritance | inheritance mode to be used. |
Definition at line 572 of file network.h.
References isc::dhcp::CfgGlobals::DDNS_OVERRIDE_CLIENT_UPDATE.
|
inline |
Returns ddns-override-no-update.
inheritance | inheritance mode to be used. |
Definition at line 555 of file network.h.
References isc::dhcp::CfgGlobals::DDNS_OVERRIDE_NO_UPDATE.
|
inline |
Returns ddns-qualifying-suffix.
inheritance | inheritance mode to be used. |
Definition at line 653 of file network.h.
References isc::dhcp::CfgGlobals::DDNS_QUALIFYING_SUFFIX.
|
inline |
Returns ddns-replace-client-name-mode.
inheritance | inheritance mode to be used. |
Definition at line 590 of file network.h.
References isc::dhcp::CfgGlobals::DDNS_REPLACE_CLIENT_NAME, isc::util::Optional< T >::get(), isc::log::NONE, isc::dhcp::D2ClientConfig::stringToReplaceClientNameMode(), and isc::util::Optional< T >::unspecified().
|
inline |
Returns ddns-send-updates.
inheritance | inheritance mode to be used. |
Definition at line 538 of file network.h.
References isc::dhcp::CfgGlobals::DDNS_SEND_UPDATES.
|
inline |
Returns ddns-update-on-renew.
inheritance | inheritance mode to be used. |
Definition at line 751 of file network.h.
References isc::dhcp::CfgGlobals::DDNS_UPDATE_ON_RENEW.
|
inline |
Returns ddns-use-conflict-resolution.
inheritance | inheritance mode to be used. |
Definition at line 768 of file network.h.
References isc::dhcp::CfgGlobals::DDNS_USE_CONFLICT_RESOLUTION.
|
inlineprotected |
|
inlineprotected |
Returns a value of global configuration parameter with a given index.
If the ferch_globals_fn_
function is non-null, this method will invoke this function to retrieve a global value having the given index. Typically, this method is invoked by getProperty
when network specific value of the parameter is not found. In some cases it may be called by other methods. One such example is the getDdnsReplaceClientNameMode
which needs to call getGlobalProperty
explicitly to convert the global replace client name mode value from a string to an enum.
ReturnType | Type of the returned value, e.g. Optional<std::string> . |
property | Value to be returned when it is specified or when no global value is found. |
global_index | Index of the global parameter which value should be returned |
min_index | Index of the min global parameter which value should be returned for triplets |
max_index | Index of the max global parameter which value should be returned for triplets |
property
.
|
inlineprotected |
The getGlobalProperty
specialization for isc::util::Triplet<T>.
NumType | Type of the encapsulated value(s). |
property | Value to be returned when it is specified or when no global value is found. |
global_index | Index of the global parameter which value should be returned |
min_index | Index of the min global parameter which value should be returned for triplets |
max_index | Index of the max global parameter which value should be returned for triplets |
property
.
|
protected |
The getGlobalProperty
specialization for Optional<IOAddress>.
This does two things:
property | Value to be returned when it is specified or when no global value is found. |
global_index | Index of the global parameter which value should be returned |
min_index | Index of the min global parameter which value should be returned for triplets |
max_index | Index of the max global parameter which value should be returned for triplets |
property
. Definition at line 97 of file network.cc.
|
inline |
Return the invalid char replacement used to sanitize client hostnames.
Definition at line 683 of file network.h.
References isc::dhcp::CfgGlobals::HOSTNAME_CHAR_REPLACEMENT.
|
inline |
Return the char set regexp used to sanitize client hostnames.
Definition at line 668 of file network.h.
References isc::dhcp::CfgGlobals::HOSTNAME_CHAR_SET.
|
inline |
|
inlineprotected |
Returns option pointer associated with a network using inheritance.
This template method provides a generic mechanism to retrieve a network parameter using inheritance. It is called from public accessor methods which return an OptionPtr
.
BaseType | Type of this instance, e.g. Network , Network4 etc, which exposes a method to be called. |
MethodPointer | Pointer to the method of the base class which should be called on the parent network instance (typically on SharedNetwork4 or SharedNetwork6 ) to fetch the parent specific value if the value is unspecified for this instance. |
property | the value to return when inheritance mode is NONE, or when the mode is PARENT_NETWORK and the property has not been specified by a parent network. |
inheritance | inheritance mode to be used. |
Definition at line 1049 of file network.h.
References GLOBAL, NONE, and PARENT_NETWORK.
|
inlineprotected |
Returns a value associated with a network using inheritance.
This template method provides a generic mechanism to retrieve a network parameter using inheritance. It is called from public accessor methods which return an OptionalValue
or isc::util::Triplet
.
BaseType | Type of this instance, e.g. Network , Network4 etc, which exposes a method to be called. |
ReturnType | Type of the returned value, e.g. Optional<std::string> . |
MethodPointer | Pointer to the method of the base class which should be called on the parent network instance (typically on SharedNetwork4 or SharedNetwork6 ) to fetch the parent specific value if the value is unspecified for this instance. |
property | Value to be returned when it is specified or when no explicit value is specified on upper inheritance levels. |
inheritance | inheritance mode to be used. |
global_index | Optional index of the global parameter which value should be returned if the given parameter is not specified on network level. This value is empty by default, which indicates that the global value for the given parameter is not supported and shouldn't be fetched. |
min_index | Index of the min global parameter which value should be returned for triplets |
max_index | Index of the max global parameter which value should be returned for triplets |
Definition at line 973 of file network.h.
References isc::log::NONE, and NONE.
const IOAddressList & isc::dhcp::Network::getRelayAddresses | ( | ) | const |
Returns the list of relay addresses from the network's relay info.
Definition at line 64 of file network.cc.
|
inline |
const ClientClasses & isc::dhcp::Network::getRequiredClasses | ( | ) | const |
Returns classes which are required to be evaluated.
Definition at line 92 of file network.cc.
|
inline |
Returns whether global reservations should be fetched.
inheritance | inheritance mode to be used. |
Definition at line 423 of file network.h.
References isc::dhcp::CfgGlobals::RESERVATIONS_GLOBAL.
|
inline |
Returns whether subnet reservations should be fetched.
inheritance | inheritance mode to be used. |
Definition at line 441 of file network.h.
References isc::dhcp::CfgGlobals::RESERVATIONS_IN_SUBNET.
|
inline |
Returns whether only out-of-pool reservations are allowed.
inheritance | inheritance mode to be used. |
Definition at line 459 of file network.h.
References isc::dhcp::CfgGlobals::RESERVATIONS_OUT_OF_POOL.
|
inline |
Returns store-extended-info.
inheritance | inheritance mode to be used. |
Definition at line 701 of file network.h.
References isc::dhcp::CfgGlobals::STORE_EXTENDED_INFO.
|
inline |
Returns T1 (renew timer), expressed in seconds.
inheritance | inheritance mode to be used. |
Definition at line 392 of file network.h.
References isc::dhcp::CfgGlobals::RENEW_TIMER.
|
inline |
Returns percentage to use when calculating the T1 (renew timer).
inheritance | inheritance mode to be used. |
Definition at line 506 of file network.h.
References isc::dhcp::CfgGlobals::T1_PERCENT.
|
inline |
Returns T2 (rebind timer), expressed in seconds.
inheritance | inheritance mode to be used. |
Definition at line 407 of file network.h.
References isc::dhcp::CfgGlobals::REBIND_TIMER.
|
inline |
Returns percentage to use when calculating the T2 (rebind timer).
inheritance | inheritance mode to be used. |
Definition at line 522 of file network.h.
References isc::dhcp::CfgGlobals::T2_PERCENT.
|
inline |
Return valid-lifetime for addresses in that prefix.
inheritance | inheritance mode to be used. |
Definition at line 375 of file network.h.
References isc::dhcp::CfgGlobals::MAX_VALID_LIFETIME, isc::dhcp::CfgGlobals::MIN_VALID_LIFETIME, and isc::dhcp::CfgGlobals::VALID_LIFETIME.
|
inline |
bool isc::dhcp::Network::hasRelayAddress | ( | const asiolink::IOAddress & | address | ) | const |
Tests if the network's relay info contains the given address.
address | address to search for in the relay list |
Definition at line 59 of file network.cc.
bool isc::dhcp::Network::hasRelays | ( | ) | const |
Indicates if network's relay info has relay addresses.
Definition at line 54 of file network.cc.
void isc::dhcp::Network::requireClientClass | ( | const isc::dhcp::ClientClass & | class_name | ) |
Adds class class_name to classes required to be evaluated.
class_name | client class required to be evaluated |
Definition at line 85 of file network.cc.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Sets local name of the interface for which this network is selected.
If the interface is specified, the server will use the network associated with this local interface to allocate IP addresses and other resources to a client. Empty values are translated into unspecified.
iface_name | Interface name. |
Definition at line 255 of file network.h.
References isc::util::Optional< T >::empty().
|
inline |
Sets information about relay.
In some situations where there are shared subnets (i.e. two different subnets are available on the same physical link), there is only one relay that handles incoming requests from clients. In such a case, the usual subnet selection criteria based on relay belonging to the subnet being selected are no longer sufficient and we need to explicitly specify a relay. One notable example of such uncommon, but valid scenario is a cable network, where there is only one CMTS (one relay), but there are 2 distinct subnets behind it: one for cable modems and another one for CPEs and other user equipment behind modems. From manageability perspective, it is essential that modems get addresses from different subnet, so users won't tinker with their modems.
Setting this parameter is not needed in most deployments. This structure holds IP address only for now, but it is expected to be extended in the future.
relay | structure that contains relay information |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Sets new renew timer for a network.
t1 | New renew timer value in seconds. |
Definition at line 400 of file network.h.
Referenced by isc::dhcp::Subnet4::Subnet4(), and isc::dhcp::Subnet6::Subnet6().
|
inline |
|
inline |
Sets new rebind timer for a network.
t2 | New rebind timer value in seconds. |
Definition at line 415 of file network.h.
Referenced by isc::dhcp::Subnet4::Subnet4(), and isc::dhcp::Subnet6::Subnet6().
|
inline |
|
inline |
Sets new valid lifetime for a network.
valid | New valid lifetime in seconds. |
Definition at line 385 of file network.h.
Referenced by isc::dhcp::Subnet4::Subnet4(), and isc::dhcp::Subnet6::Subnet6().
|
virtual |
Unparses network object.
Implements isc::data::CfgToElement.
Reimplemented in isc::dhcp::Network6, isc::dhcp::Network4, isc::dhcp::Subnet6, isc::dhcp::Subnet4, isc::dhcp::Subnet, isc::dhcp::SharedNetwork6, and isc::dhcp::SharedNetwork4.
Definition at line 117 of file network.cc.
References isc::dhcp::ClientClasses::cbegin(), isc::dhcp::ClientClasses::cend(), and isc::dhcp::ClientClasses::empty().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Pointer to another network that this network belongs to.
The most common case is that this instance is a subnet which belongs to a shared network and the parent_network_
points to the shared network object. If the network instance (subnet) doesn't belong to a shared network this pointer is null.
Definition at line 1197 of file network.h.
Referenced by isc::dhcp::Subnet::getSharedNetwork(), and isc::dhcp::Subnet::setSharedNetwork().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Enables out-of-pool reservations optimization.
When true only out-of-pool reservations are allowed. This allows AllocEngine to skip reservation checks when dealing with addresses that are in pool.
|
protected |
|
protected |
a isc::util::Triplet (min/default/max) holding allowed renew timer values
|
protected |
|
protected |
a isc::util::Triplet (min/default/max) holding allowed rebind timer values
|
protected |
|
protected |
a isc::util::Triplet (min/default/max) holding allowed valid lifetime values