Common interface representing a network to which the DHCP clients are connected. More...

#include <network.h>

Inheritance diagram for isc::dhcp::Network:

Classes
class	RelayInfo
	Holds optional information about relay. More...

Public Types
enum class	Inheritance { NONE , PARENT_NETWORK , GLOBAL , ALL }
	Inheritance "mode" used when fetching an optional `Network` parameter. More...

typedef boost::shared_ptr< Network::RelayInfo >	RelayInfoPtr
	Pointer to the RelayInfo structure.

Public Member Functions
	Network ()
	Constructor.

virtual	~Network ()
	Virtual destructor.

void	addRelayAddress (const asiolink::IOAddress &addr)
	Adds an address to the list addresses in the network's relay info.

void	allowClientClass (const isc::dhcp::ClientClass &class_name)
	Sets the supported class to class class_name.

virtual bool	clientSupported (const isc::dhcp::ClientClasses &client_classes) const
	Checks whether this network supports client that belongs to specified classes.

util::Optional< std::string >	getAllocatorType (const Inheritance &inheritance=Inheritance::ALL) const
	Returns allocator type.

util::Optional< uint32_t >	getCacheMaxAge (const Inheritance &inheritance=Inheritance::ALL) const
	Returns value in seconds to use as cache maximum age.

util::Optional< double >	getCacheThreshold (const Inheritance &inheritance=Inheritance::ALL) const
	Returns percentage to use as cache threshold.

util::Optional< bool >	getCalculateTeeTimes (const Inheritance &inheritance=Inheritance::ALL) const
	Returns whether or not T1/T2 calculation is enabled.

CfgOptionPtr	getCfgOption ()
	Returns pointer to the option data configuration for this network.

ConstCfgOptionPtr	getCfgOption () const
	Returns const pointer to the option data configuration for this network.

util::Optional< ClientClass >	getClientClass (const Inheritance &inheritance=Inheritance::ALL) const
	returns the client class

util::Optional< std::string >	getDdnsConflictResolutionMode (const Inheritance &inheritance=Inheritance::ALL) const
	Returns ib-ddns-conflict-resolution-mode.

util::Optional< std::string >	getDdnsGeneratedPrefix (const Inheritance &inheritance=Inheritance::ALL) const
	Returns ddns-generated-prefix.

util::Optional< bool >	getDdnsOverrideClientUpdate (const Inheritance &inheritance=Inheritance::ALL) const
	Returns ddns-override-client-update.

util::Optional< bool >	getDdnsOverrideNoUpdate (const Inheritance &inheritance=Inheritance::ALL) const
	Returns ddns-override-no-update.

util::Optional< std::string >	getDdnsQualifyingSuffix (const Inheritance &inheritance=Inheritance::ALL) const
	Returns ddns-qualifying-suffix.

util::Optional< D2ClientConfig::ReplaceClientNameMode >	getDdnsReplaceClientNameMode (const Inheritance &inheritance=Inheritance::ALL) const
	Returns ddns-replace-client-name-mode.

util::Optional< bool >	getDdnsSendUpdates (const Inheritance &inheritance=Inheritance::ALL) const
	Returns ddns-send-updates.

util::Optional< double >	getDdnsTtlPercent (const Inheritance &inheritance=Inheritance::ALL) const
	Returns ddns-ttl-percent.

util::Optional< bool >	getDdnsUpdateOnRenew (const Inheritance &inheritance=Inheritance::ALL) const
	Returns ddns-update-on-renew.

util::Optional< std::string >	getDefaultAllocatorType (const Inheritance &inheritance=Inheritance::ALL) const
	Returns a default allocator type.

util::Optional< std::string >	getHostnameCharReplacement (const Inheritance &inheritance=Inheritance::ALL) const
	Return the invalid char replacement used to sanitize client hostnames.

util::Optional< std::string >	getHostnameCharSet (const Inheritance &inheritance=Inheritance::ALL) const
	Return the char set regexp used to sanitize client hostnames.

util::Optional< std::string >	getIface (const Inheritance &inheritance=Inheritance::ALL) const
	Returns name of the local interface for which this network is selected.

virtual std::string	getLabel () const
	Generates an identifying label for logging.

const IOAddressList &	getRelayAddresses () const
	Returns the list of relay addresses from the network's relay info.

const RelayInfo &	getRelayInfo () const
	Returns const reference to relay information.

const ClientClasses &	getRequiredClasses () const
	Returns classes which are required to be evaluated.

util::Optional< bool >	getReservationsGlobal (const Inheritance &inheritance=Inheritance::ALL) const
	Returns whether global reservations should be fetched.

util::Optional< bool >	getReservationsInSubnet (const Inheritance &inheritance=Inheritance::ALL) const
	Returns whether subnet reservations should be fetched.

util::Optional< bool >	getReservationsOutOfPool (const Inheritance &inheritance=Inheritance::ALL) const
	Returns whether only out-of-pool reservations are allowed.

util::Optional< bool >	getStoreExtendedInfo (const Inheritance &inheritance=Inheritance::ALL) const
	Returns store-extended-info.

isc::util::Triplet< uint32_t >	getT1 (const Inheritance &inheritance=Inheritance::ALL) const
	Returns T1 (renew timer), expressed in seconds.

util::Optional< double >	getT1Percent (const Inheritance &inheritance=Inheritance::ALL) const
	Returns percentage to use when calculating the T1 (renew timer).

isc::util::Triplet< uint32_t >	getT2 (const Inheritance &inheritance=Inheritance::ALL) const
	Returns T2 (rebind timer), expressed in seconds.

util::Optional< double >	getT2Percent (const Inheritance &inheritance=Inheritance::ALL) const
	Returns percentage to use when calculating the T2 (rebind timer).

isc::util::Triplet< uint32_t >	getValid (const Inheritance &inheritance=Inheritance::ALL) const
	Return valid-lifetime for addresses in that prefix.

bool	hasFetchGlobalsFn () const
	Checks if the network is associated with a function used to fetch globally configured parameters.

bool	hasRelayAddress (const asiolink::IOAddress &address) const
	Tests if the network's relay info contains the given address.

bool	hasRelays () const
	Indicates if network's relay info has relay addresses.

void	requireClientClass (const isc::dhcp::ClientClass &class_name)
	Adds class class_name to classes required to be evaluated.

void	setAllocatorType (const util::Optional< std::string > &allocator_type)
	Sets new allocator type.

void	setCacheMaxAge (const util::Optional< uint32_t > &cache_max_age)
	Sets cache max for a network.

void	setCacheThreshold (const util::Optional< double > &cache_threshold)
	Sets cache threshold for a network.

void	setCalculateTeeTimes (const util::Optional< bool > &calculate_tee_times)
	Sets whether or not T1/T2 calculation is enabled.

void	setDdnsConflictResolutionMode (const util::Optional< std::string > &ddns_conflict_resolution_mode)
	Sets new ib-ddns-conflict-resolution-mode.

void	setDdnsGeneratedPrefix (const util::Optional< std::string > &ddns_generated_prefix)
	Sets new ddns-generated-prefix.

void	setDdnsOverrideClientUpdate (const util::Optional< bool > &ddns_override_client_update)
	Sets new ddns-override-client-update.

void	setDdnsOverrideNoUpdate (const util::Optional< bool > &ddns_override_no_update)
	Sets new ddns-override-no-update.

void	setDdnsQualifyingSuffix (const util::Optional< std::string > &ddns_qualifying_suffix)
	Sets new ddns-qualifying-suffix.

void	setDdnsReplaceClientNameMode (const util::Optional< D2ClientConfig::ReplaceClientNameMode > &ddns_replace_client_name_mode)
	Sets new ddns-replace-client-name-mode.

void	setDdnsSendUpdates (const util::Optional< bool > &ddns_send_updates)
	Sets new ddns-send-updates.

void	setDdnsTtlPercent (const util::Optional< double > &ddns_ttl_percent)
	Sets new ddns-ttl-percent.

void	setDdnsUpdateOnRenew (const util::Optional< bool > &ddns_update_on_renew)
	Sets new ddns-update-on-renew.

void	setDefaultAllocatorType (const std::string &allocator_type)
	Sets a defalt allocator type.

void	setFetchGlobalsFn (FetchNetworkGlobalsFn fetch_globals_fn)
	Sets the optional callback function used to fetch globally configured parameters.

void	setHostnameCharReplacement (const util::Optional< std::string > &hostname_char_replacement)
	Sets new hostname-char-replacement.

void	setHostnameCharSet (const util::Optional< std::string > &hostname_char_set)
	Sets new hostname-char-set.

void	setIface (const util::Optional< std::string > &iface_name)
	Sets local name of the interface for which this network is selected.

void	setRelayInfo (const RelayInfo &relay)
	Sets information about relay.

void	setReservationsGlobal (const util::Optional< bool > &reservations_global)
	Sets whether global reservations should be fetched.

void	setReservationsInSubnet (const util::Optional< bool > &reservations_in_subnet)
	Sets whether subnet reservations should be fetched.

void	setReservationsOutOfPool (const util::Optional< bool > &reservations_out_of_pool)
	Sets whether only out-of-pool reservations are allowed.

void	setStoreExtendedInfo (const util::Optional< bool > &store_extended_info)
	Sets new store-extended-info.

void	setT1 (const isc::util::Triplet< uint32_t > &t1)
	Sets new renew timer for a network.

void	setT1Percent (const util::Optional< double > &t1_percent)
	Sets new percentage for calculating T1 (renew timer).

void	setT2 (const isc::util::Triplet< uint32_t > &t2)
	Sets new rebind timer for a network.

void	setT2Percent (const util::Optional< double > &t2_percent)
	Sets new percentage for calculating T2 (rebind timer).

void	setValid (const isc::util::Triplet< uint32_t > &valid)
	Sets new valid lifetime for a network.

virtual data::ElementPtr	toElement () const
	Unparses network object.

Public Member Functions inherited from isc::data::StampedElement
	StampedElement ()
	Constructor.

void	delServerTag (const std::string &server_tag)
	Deletes server tag.

isc::data::ElementPtr	getMetadata () const
	Returns an object representing metadata to be returned with objects from the configuration backend.

std::set< ServerTag >	getServerTags () const
	Returns server tags.

bool	hasAllServerTag () const
	Checks if the element has 'all' server tag.

bool	hasServerTag (const ServerTag &server_tag) const
	Checks if the element has the given server tag.

void	setServerTag (const std::string &server_tag)
	Adds new server tag.

Public Member Functions inherited from isc::data::BaseStampedElement
	BaseStampedElement ()
	Constructor.

uint64_t	getId () const
	Returns element's database identifier.

boost::posix_time::ptime	getModificationTime () const
	Returns timestamp.

void	setId (const uint64_t id)
	Sets element's database identifier.

void	setModificationTime (const boost::posix_time::ptime &timestamp)
	Sets timestamp to the explicitly provided value.

void	updateModificationTime ()
	Sets timestamp to the current time.

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

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

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

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

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

Protected Member Functions
FetchNetworkGlobalsFn	getFetchGlobalsFn () const
	Gets the optional callback function used to fetch globally configured parameters.

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>.

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.

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>.

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.

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.

Protected Attributes
util::Optional< std::string >	allocator_type_
	Allocator used for IP address allocations.

util::Optional< uint32_t >	cache_max_age_
	Value in seconds to use as cache maximal age.

util::Optional< double >	cache_threshold_
	Percentage of the lease lifetime to use as cache threshold.

util::Optional< bool >	calculate_tee_times_
	Enables calculation of T1 and T2 timers.

CfgOptionPtr	cfg_option_
	Pointer to the option data configuration for this subnet.

util::Optional< ClientClass >	client_class_
	Optional definition of a client class.

util::Optional< std::string >	ddns_conflict_resolution_mode_
	DDNS conflict resolution mode.

util::Optional< std::string >	ddns_generated_prefix_
	Prefix Kea should use when generating domain-names.

util::Optional< bool >	ddns_override_client_update_
	Should Kea perform updates, even if client requested delegation.

util::Optional< bool >	ddns_override_no_update_
	Should Kea perform updates, even if client requested no updates.

util::Optional< std::string >	ddns_qualifying_suffix_
	Suffix Kea should use when to qualify partial domain-names.

util::Optional< D2ClientConfig::ReplaceClientNameMode >	ddns_replace_client_name_mode_
	How Kea should handle the domain-name supplied by the client.

util::Optional< bool >	ddns_send_updates_
	Should Kea perform DNS updates.

util::Optional< double >	ddns_ttl_percent_
	Percentage of the lease lifetime to use for DNS TTL.

util::Optional< bool >	ddns_update_on_renew_
	Should Kea perform updates when leases are extended.

util::Optional< std::string >	default_allocator_type_
	Default allocator type.

FetchNetworkGlobalsFn	fetch_globals_fn_
	Pointer to the optional callback used to fetch globally configured parameters inherited to the `Network` object.

util::Optional< std::string >	hostname_char_replacement_
	A string to replace invalid characters when scrubbing hostnames.

util::Optional< std::string >	hostname_char_set_
	Regular expression describing invalid characters for client hostnames.

util::Optional< std::string >	iface_name_
	Holds interface name for which this network is selected.

WeakNetworkPtr	parent_network_
	Pointer to another network that this network belongs to.

RelayInfo	relay_
	Relay information.

ClientClasses	required_classes_
	Required classes.

util::Optional< bool >	reservations_global_
	Enables global reservations.

util::Optional< bool >	reservations_in_subnet_
	Enables subnet reservations.

util::Optional< bool >	reservations_out_of_pool_
	Enables out-of-pool reservations optimization.

util::Optional< bool >	store_extended_info_
	Should Kea store additional client query data (e.g.

isc::util::Triplet< uint32_t >	t1_
	a isc::util::Triplet (min/default/max) holding allowed renew timer values

util::Optional< double >	t1_percent_
	Percentage of the lease lifetime to use when calculating T1 timer.

isc::util::Triplet< uint32_t >	t2_
	a isc::util::Triplet (min/default/max) holding allowed rebind timer values

util::Optional< double >	t2_percent_
	Percentage of the lease lifetime to use when calculating T2 timer.

isc::util::Triplet< uint32_t >	valid_
	a isc::util::Triplet (min/default/max) holding allowed valid lifetime values

Protected Attributes inherited from isc::data::BaseStampedElement
uint64_t	id_
	Database identifier of the configuration element.

boost::posix_time::ptime	timestamp_
	Holds timestamp value.

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

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

Detailed Description

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.

Definition at line 152 of file network.h.

Member Typedef Documentation

◆ RelayInfoPtr

typedef boost::shared_ptr<Network::RelayInfo> isc::dhcp::Network::RelayInfoPtr

Pointer to the RelayInfo structure.

Definition at line 210 of file network.h.

Member Enumeration Documentation

◆ Inheritance

enum class isc::dhcp::Network::Inheritance

strong

Inheritance "mode" used when fetching an optional Network parameter.

The following modes are currently supported:

NONE: no inheritance is used, the network specific value is returned regardless if it is specified or not.
PARENT_NETWORK: parent network specific value is returned or unspecified if the parent network doesn't exist.
GLOBAL: global specific value is returned.
ALL: inheritance is used on all levels: network specific value takes precedence over parent specific value over the global value.

Enumerator
NONE
PARENT_NETWORK
GLOBAL
ALL

Definition at line 202 of file network.h.

Constructor & Destructor Documentation

◆ Network()

isc::dhcp::Network::Network ( )

inline

Constructor.

Definition at line 213 of file network.h.

◆ ~Network()

virtual isc::dhcp::Network::~Network ( )

inlinevirtual

Virtual destructor.

Does nothing at the moment.

Definition at line 229 of file network.h.

Member Function Documentation

◆ addRelayAddress()

void isc::dhcp::Network::addRelayAddress ( const asiolink::IOAddress & addr )

Adds an address to the list addresses in the network's relay info.

Parameters

addr	address of the relay

Exceptions

BadValue if the address is already in the list

Definition at line 49 of file network.cc.

References isc::dhcp::Network::RelayInfo::addAddress(), and relay_.

Here is the call graph for this function:

◆ allowClientClass()

void isc::dhcp::Network::allowClientClass ( const isc::dhcp::ClientClass & class_name )

Sets the supported class to class class_name.

Parameters

class_name client class to be supported by this network

Definition at line 80 of file network.cc.

References client_class_.

◆ clientSupported()

bool isc::dhcp::Network::clientSupported ( const isc::dhcp::ClientClasses & client_classes ) const

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.

Note: : changed the planned white and black lists idea to a simple client class name.

Parameters

client_classes list of all classes the client belongs to

Returns: true if client can be supported, false otherwise

Reimplemented in isc::dhcp::Subnet4, and isc::dhcp::Subnet6.

Definition at line 69 of file network.cc.

References client_class_, isc::dhcp::ClientClasses::contains(), and isc::util::Optional< T >::empty().

Referenced by isc::dhcp::Subnet4::clientSupported(), and isc::dhcp::Subnet6::clientSupported().

Here is the call graph for this function:

◆ getAllocatorType()

util::Optional< std::string > isc::dhcp::Network::getAllocatorType ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns allocator type.

Parameters

inheritance inheritance mode to be used.

Definition at line 805 of file network.h.

References isc::dhcp::CfgGlobals::ALLOCATOR, allocator_type_, and getAllocatorType().

Referenced by isc::dhcp::Subnet4::createAllocators(), isc::dhcp::Subnet6::createAllocators(), and getAllocatorType().

Here is the call graph for this function:

◆ getCacheMaxAge()

util::Optional< uint32_t > isc::dhcp::Network::getCacheMaxAge ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns value in seconds to use as cache maximum age.

Parameters

inheritance inheritance mode to be used.

Definition at line 753 of file network.h.

References isc::dhcp::CfgGlobals::CACHE_MAX_AGE, cache_max_age_, and getCacheMaxAge().

Referenced by getCacheMaxAge().

Here is the call graph for this function:

◆ getCacheThreshold()

util::Optional< double > isc::dhcp::Network::getCacheThreshold ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns percentage to use as cache threshold.

Parameters

inheritance inheritance mode to be used.

Definition at line 736 of file network.h.

References isc::dhcp::CfgGlobals::CACHE_THRESHOLD, cache_threshold_, and getCacheThreshold().

Referenced by getCacheThreshold().

Here is the call graph for this function:

◆ getCalculateTeeTimes()

util::Optional< bool > isc::dhcp::Network::getCalculateTeeTimes ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns whether or not T1/T2 calculation is enabled.

Parameters

inheritance inheritance mode to be used.

Definition at line 489 of file network.h.

References isc::dhcp::CfgGlobals::CALCULATE_TEE_TIMES, calculate_tee_times_, and getCalculateTeeTimes().

Referenced by getCalculateTeeTimes().

Here is the call graph for this function:

◆ getCfgOption() [1/2]

CfgOptionPtr isc::dhcp::Network::getCfgOption ( )

inline

Returns pointer to the option data configuration for this network.

Definition at line 475 of file network.h.

References cfg_option_.

Referenced by toElement().

◆ getCfgOption() [2/2]

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

inline

Returns const pointer to the option data configuration for this network.

Definition at line 481 of file network.h.

References cfg_option_.

◆ getClientClass()

util::Optional< ClientClass > isc::dhcp::Network::getClientClass ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

returns the client class

Note: The returned reference is only valid as long as the object returned it is valid.

Parameters

inheritance inheritance mode to be used.

Returns: client class client_class_

Definition at line 368 of file network.h.

References client_class_, and getClientClass().

Referenced by getClientClass().

Here is the call graph for this function:

◆ getDdnsConflictResolutionMode()

util::Optional< std::string > isc::dhcp::Network::getDdnsConflictResolutionMode ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns ib-ddns-conflict-resolution-mode.

Parameters

inheritance inheritance mode to be used.

Definition at line 787 of file network.h.

References isc::dhcp::CfgGlobals::DDNS_CONFLICT_RESOLUTION_MODE, ddns_conflict_resolution_mode_, and getDdnsConflictResolutionMode().

Referenced by getDdnsConflictResolutionMode().

Here is the call graph for this function:

◆ getDdnsGeneratedPrefix()

util::Optional< std::string > isc::dhcp::Network::getDdnsGeneratedPrefix ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns ddns-generated-prefix.

Parameters

inheritance inheritance mode to be used.

Definition at line 637 of file network.h.

References isc::dhcp::CfgGlobals::DDNS_GENERATED_PREFIX, ddns_generated_prefix_, and getDdnsGeneratedPrefix().

Referenced by getDdnsGeneratedPrefix().

Here is the call graph for this function:

◆ getDdnsOverrideClientUpdate()

util::Optional< bool > isc::dhcp::Network::getDdnsOverrideClientUpdate ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns ddns-override-client-update.

Parameters

inheritance inheritance mode to be used.

Definition at line 573 of file network.h.

References isc::dhcp::CfgGlobals::DDNS_OVERRIDE_CLIENT_UPDATE, ddns_override_client_update_, and getDdnsOverrideClientUpdate().

Referenced by getDdnsOverrideClientUpdate().

Here is the call graph for this function:

◆ getDdnsOverrideNoUpdate()

util::Optional< bool > isc::dhcp::Network::getDdnsOverrideNoUpdate ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns ddns-override-no-update.

Parameters

inheritance inheritance mode to be used.

Definition at line 556 of file network.h.

References isc::dhcp::CfgGlobals::DDNS_OVERRIDE_NO_UPDATE, ddns_override_no_update_, and getDdnsOverrideNoUpdate().

Referenced by getDdnsOverrideNoUpdate().

Here is the call graph for this function:

◆ getDdnsQualifyingSuffix()

util::Optional< std::string > isc::dhcp::Network::getDdnsQualifyingSuffix ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns ddns-qualifying-suffix.

Parameters

inheritance inheritance mode to be used.

Definition at line 654 of file network.h.

References isc::dhcp::CfgGlobals::DDNS_QUALIFYING_SUFFIX, ddns_qualifying_suffix_, and getDdnsQualifyingSuffix().

Referenced by getDdnsQualifyingSuffix().

Here is the call graph for this function:

◆ getDdnsReplaceClientNameMode()

util::Optional< D2ClientConfig::ReplaceClientNameMode > isc::dhcp::Network::getDdnsReplaceClientNameMode ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns ddns-replace-client-name-mode.

Parameters

inheritance inheritance mode to be used.

Definition at line 591 of file network.h.

References isc::dhcp::CfgGlobals::DDNS_REPLACE_CLIENT_NAME, ddns_replace_client_name_mode_, isc::util::Optional< T >::get(), getDdnsReplaceClientNameMode(), getGlobalProperty(), NONE, PARENT_NETWORK, isc::dhcp::D2ClientConfig::stringToReplaceClientNameMode(), and isc::util::Optional< T >::unspecified().

Referenced by getDdnsReplaceClientNameMode().

Here is the call graph for this function:

◆ getDdnsSendUpdates()

util::Optional< bool > isc::dhcp::Network::getDdnsSendUpdates ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns ddns-send-updates.

Parameters

inheritance inheritance mode to be used.

Definition at line 539 of file network.h.

References isc::dhcp::CfgGlobals::DDNS_SEND_UPDATES, ddns_send_updates_, and getDdnsSendUpdates().

Referenced by getDdnsSendUpdates().

Here is the call graph for this function:

◆ getDdnsTtlPercent()

util::Optional< double > isc::dhcp::Network::getDdnsTtlPercent ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns ddns-ttl-percent.

Parameters

inheritance inheritance mode to be used.

Definition at line 671 of file network.h.

References isc::dhcp::CfgGlobals::DDNS_TTL_PERCENT, ddns_ttl_percent_, and getDdnsTtlPercent().

Referenced by getDdnsTtlPercent().

Here is the call graph for this function:

◆ getDdnsUpdateOnRenew()

util::Optional< bool > isc::dhcp::Network::getDdnsUpdateOnRenew ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns ddns-update-on-renew.

Parameters

inheritance inheritance mode to be used.

Definition at line 769 of file network.h.

References isc::dhcp::CfgGlobals::DDNS_UPDATE_ON_RENEW, ddns_update_on_renew_, and getDdnsUpdateOnRenew().

Referenced by getDdnsUpdateOnRenew().

Here is the call graph for this function:

◆ getDefaultAllocatorType()

util::Optional< std::string > isc::dhcp::Network::getDefaultAllocatorType ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns a default allocator type.

This allocator type is used when the allocator type is neither specified at the shared network nor subnet level.

Returns: an allocator type as a string.

Definition at line 830 of file network.h.

References default_allocator_type_, and getDefaultAllocatorType().

Referenced by isc::dhcp::Subnet4::createAllocators(), isc::dhcp::Subnet6::createAllocators(), and getDefaultAllocatorType().

Here is the call graph for this function:

◆ getFetchGlobalsFn()

FetchNetworkGlobalsFn isc::dhcp::Network::getFetchGlobalsFn ( ) const

inlineprotected

Gets the optional callback function used to fetch globally configured parameters.

Returns: Pointer to the function.

Definition at line 861 of file network.h.

References fetch_globals_fn_.

◆ getGlobalProperty() [1/3]

template<typename NumType >

isc::util::Triplet< NumType > isc::dhcp::Network::getGlobalProperty	(	isc::util::Triplet< NumType >	property,
		const int	global_index,
		const int	min_index = `-1`,
		const int	max_index = `-1`
	)		const

inlineprotected

The getGlobalProperty specialization for isc::util::Triplet<T>.

Note: : use overloading vs specialization because full specialization is not allowed in this scope.

Template Parameters

NumType Type of the encapsulated value(s).

Parameters

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

Returns: Optional value fetched from the global level or the value of property.

Definition at line 930 of file network.h.

References fetch_globals_fn_.

◆ getGlobalProperty() [2/3]

template<typename ReturnType >

ReturnType isc::dhcp::Network::getGlobalProperty	(	ReturnType	property,
		const int	global_index,
		const int	min_index = `-1`,
		const int	max_index = `-1`
	)		const

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.

Template Parameters

ReturnType Type of the returned value, e.g. Optional<std::string>.

Parameters

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

Returns: Optional value fetched from the global level or the value of property.

Definition at line 892 of file network.h.

References fetch_globals_fn_.

Referenced by getDdnsReplaceClientNameMode(), and getProperty().

◆ getGlobalProperty() [3/3]

Optional< IOAddress > isc::dhcp::Network::getGlobalProperty	(	util::Optional< asiolink::IOAddress >	property,
		const int	global_index,
		const int	min_index = `-1`,
		const int	max_index = `-1`
	)		const

protected

The getGlobalProperty specialization for Optional<IOAddress>.

This does two things:

uses the string value of the parameter
falls back when the value is empty

Note: : use overloading vs specialization because full specialization is not allowed in this scope.

Parameters

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

Returns: Optional value fetched from the global level or the value of property.

Definition at line 97 of file network.cc.

References fetch_globals_fn_.

◆ getHostnameCharReplacement()

util::Optional< std::string > isc::dhcp::Network::getHostnameCharReplacement ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Return the invalid char replacement used to sanitize client hostnames.

Definition at line 701 of file network.h.

References getHostnameCharReplacement(), isc::dhcp::CfgGlobals::HOSTNAME_CHAR_REPLACEMENT, and hostname_char_replacement_.

Referenced by getHostnameCharReplacement().

Here is the call graph for this function:

◆ getHostnameCharSet()

util::Optional< std::string > isc::dhcp::Network::getHostnameCharSet ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Return the char set regexp used to sanitize client hostnames.

Definition at line 686 of file network.h.

References getHostnameCharSet(), isc::dhcp::CfgGlobals::HOSTNAME_CHAR_SET, and hostname_char_set_.

Referenced by getHostnameCharSet().

Here is the call graph for this function:

◆ getIface()

util::Optional< std::string > isc::dhcp::Network::getIface ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns name of the local interface for which this network is selected.

Parameters

inheritance inheritance mode to be used.

Returns: Interface name as optional text.

Definition at line 270 of file network.h.

References getIface(), and iface_name_.

Referenced by getIface().

Here is the call graph for this function:

◆ getLabel()

virtual std::string isc::dhcp::Network::getLabel ( ) const

inlinevirtual

Generates an identifying label for logging.

Returns: string containing the label

Reimplemented in isc::dhcp::SharedNetwork4, isc::dhcp::SharedNetwork6, and isc::dhcp::Subnet.

Definition at line 851 of file network.h.

◆ getOptionProperty()

template<typename BaseType >

OptionPtr isc::dhcp::Network::getOptionProperty	(	OptionPtr(BaseType::*)(const Inheritance &inheritance) const	MethodPointer,
		OptionPtr	property,
		const Inheritance &	inheritance
	)		const

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.

Template Parameters

BaseType Type of this instance, e.g. Network, Network4 etc, which exposes a method to be called.

Parameters

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.

Returns: Option pointer fetched from this instance level or parent network level.

Definition at line 1095 of file network.h.

References GLOBAL, NONE, PARENT_NETWORK, and parent_network_.

◆ getProperty()

template<typename BaseType , typename ReturnType >

ReturnType isc::dhcp::Network::getProperty	(	ReturnType(BaseType::*)(const Inheritance &) const	MethodPointer,
		ReturnType	property,
		const Inheritance &	inheritance,
		const int	global_index = `-1`,
		const int	min_index = `-1`,
		const int	max_index = `-1`
	)		const

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.

Template Parameters

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>`.

Parameters

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

Returns: Optional value fetched from this instance level, parent network level or global level

Definition at line 1019 of file network.h.

References getGlobalProperty(), GLOBAL, NONE, PARENT_NETWORK, and parent_network_.

Here is the call graph for this function:

◆ getRelayAddresses()

const IOAddressList & isc::dhcp::Network::getRelayAddresses ( ) const

Returns the list of relay addresses from the network's relay info.

Returns: const reference to the list of addresses

Definition at line 64 of file network.cc.

References isc::dhcp::Network::RelayInfo::getAddresses(), and relay_.

Referenced by toElement().

Here is the call graph for this function:

◆ getRelayInfo()

const RelayInfo & isc::dhcp::Network::getRelayInfo ( ) const

inline

Returns const reference to relay information.

Note: The returned reference is only valid as long as the object returned it is valid.

Returns: const reference to the relay information

Definition at line 304 of file network.h.

References relay_.

◆ getRequiredClasses()

const ClientClasses & isc::dhcp::Network::getRequiredClasses ( ) const

Returns classes which are required to be evaluated.

Definition at line 92 of file network.cc.

References required_classes_.

Referenced by toElement().

◆ getReservationsGlobal()

util::Optional< bool > isc::dhcp::Network::getReservationsGlobal ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns whether global reservations should be fetched.

Parameters

inheritance inheritance mode to be used.

Definition at line 424 of file network.h.

References getReservationsGlobal(), isc::dhcp::CfgGlobals::RESERVATIONS_GLOBAL, and reservations_global_.

Referenced by getReservationsGlobal().

Here is the call graph for this function:

◆ getReservationsInSubnet()

util::Optional< bool > isc::dhcp::Network::getReservationsInSubnet ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns whether subnet reservations should be fetched.

Parameters

inheritance inheritance mode to be used.

Definition at line 442 of file network.h.

References getReservationsInSubnet(), isc::dhcp::CfgGlobals::RESERVATIONS_IN_SUBNET, and reservations_in_subnet_.

Referenced by getReservationsInSubnet().

Here is the call graph for this function:

◆ getReservationsOutOfPool()

util::Optional< bool > isc::dhcp::Network::getReservationsOutOfPool ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns whether only out-of-pool reservations are allowed.

Parameters

inheritance inheritance mode to be used.

Definition at line 460 of file network.h.

References getReservationsOutOfPool(), isc::dhcp::CfgGlobals::RESERVATIONS_OUT_OF_POOL, and reservations_out_of_pool_.

Referenced by getReservationsOutOfPool().

Here is the call graph for this function:

◆ getStoreExtendedInfo()

util::Optional< bool > isc::dhcp::Network::getStoreExtendedInfo ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns store-extended-info.

Parameters

inheritance inheritance mode to be used.

Definition at line 719 of file network.h.

References getStoreExtendedInfo(), isc::dhcp::CfgGlobals::STORE_EXTENDED_INFO, and store_extended_info_.

Referenced by getStoreExtendedInfo().

Here is the call graph for this function:

◆ getT1()

isc::util::Triplet< uint32_t > isc::dhcp::Network::getT1 ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns T1 (renew timer), expressed in seconds.

Parameters

inheritance inheritance mode to be used.

Definition at line 393 of file network.h.

References getT1(), isc::dhcp::CfgGlobals::RENEW_TIMER, and t1_.

Referenced by getT1().

Here is the call graph for this function:

◆ getT1Percent()

util::Optional< double > isc::dhcp::Network::getT1Percent ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns percentage to use when calculating the T1 (renew timer).

Parameters

inheritance inheritance mode to be used.

Definition at line 507 of file network.h.

References getT1Percent(), isc::dhcp::CfgGlobals::T1_PERCENT, and t1_percent_.

Referenced by getT1Percent().

Here is the call graph for this function:

◆ getT2()

isc::util::Triplet< uint32_t > isc::dhcp::Network::getT2 ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns T2 (rebind timer), expressed in seconds.

Parameters

inheritance inheritance mode to be used.

Definition at line 408 of file network.h.

References getT2(), isc::dhcp::CfgGlobals::REBIND_TIMER, and t2_.

Referenced by getT2().

Here is the call graph for this function:

◆ getT2Percent()

util::Optional< double > isc::dhcp::Network::getT2Percent ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Returns percentage to use when calculating the T2 (rebind timer).

Parameters

inheritance inheritance mode to be used.

Definition at line 523 of file network.h.

References getT2Percent(), isc::dhcp::CfgGlobals::T2_PERCENT, and t2_percent_.

Referenced by getT2Percent().

Here is the call graph for this function:

◆ getValid()

isc::util::Triplet< uint32_t > isc::dhcp::Network::getValid ( const Inheritance & inheritance = Inheritance::ALL ) const

inline

Return valid-lifetime for addresses in that prefix.

Parameters

inheritance inheritance mode to be used.

Definition at line 376 of file network.h.

References getValid(), isc::dhcp::CfgGlobals::MAX_VALID_LIFETIME, isc::dhcp::CfgGlobals::MIN_VALID_LIFETIME, valid_, and isc::dhcp::CfgGlobals::VALID_LIFETIME.

Referenced by getValid().

Here is the call graph for this function:

◆ hasFetchGlobalsFn()

bool isc::dhcp::Network::hasFetchGlobalsFn ( ) const

inline

Checks if the network is associated with a function used to fetch globally configured parameters.

Returns: true if it is associated, false otherwise.

Definition at line 243 of file network.h.

References fetch_globals_fn_.

◆ hasRelayAddress()

bool isc::dhcp::Network::hasRelayAddress ( const asiolink::IOAddress & address ) const

Tests if the network's relay info contains the given address.

Parameters

address address to search for in the relay list

Returns: True if a relay with the given address is found, false otherwise

Definition at line 59 of file network.cc.

References isc::dhcp::Network::RelayInfo::containsAddress(), and relay_.

Here is the call graph for this function:

◆ hasRelays()

bool isc::dhcp::Network::hasRelays ( ) const

Indicates if network's relay info has relay addresses.

Returns: True the relay list is not empty, false otherwise

Definition at line 54 of file network.cc.

References isc::dhcp::Network::RelayInfo::hasAddresses(), and relay_.

Here is the call graph for this function:

◆ requireClientClass()

void isc::dhcp::Network::requireClientClass ( const isc::dhcp::ClientClass & class_name )

Adds class class_name to classes required to be evaluated.

Parameters

class_name client class required to be evaluated

Definition at line 85 of file network.cc.

References isc::dhcp::ClientClasses::contains(), isc::dhcp::ClientClasses::insert(), and required_classes_.

Here is the call graph for this function:

◆ setAllocatorType()

void isc::dhcp::Network::setAllocatorType ( const util::Optional< std::string > & allocator_type )

inline

Sets new allocator type.

It doesn't set the actual allocator instance. It merely remembers the value specified in the configuration, so it can be output in the toElement call.

Parameters

allocator_type new allocator type to use.

Definition at line 819 of file network.h.

References allocator_type_.

◆ setCacheMaxAge()

void isc::dhcp::Network::setCacheMaxAge ( const util::Optional< uint32_t > & cache_max_age )

inline

Sets cache max for a network.

Parameters

cache_max_age New cache maximum value in seconds to use.

Definition at line 761 of file network.h.

References cache_max_age_.

◆ setCacheThreshold()

void isc::dhcp::Network::setCacheThreshold ( const util::Optional< double > & cache_threshold )

inline

Sets cache threshold for a network.

Parameters

cache_threshold New cache threshold percentage to use.

Definition at line 745 of file network.h.

References cache_threshold_.

◆ setCalculateTeeTimes()

void isc::dhcp::Network::setCalculateTeeTimes ( const util::Optional< bool > & calculate_tee_times )

inline

Sets whether or not T1/T2 calculation is enabled.

Parameters

calculate_tee_times new value of enabled/disabled.

Definition at line 499 of file network.h.

References calculate_tee_times_.

◆ setDdnsConflictResolutionMode()

void isc::dhcp::Network::setDdnsConflictResolutionMode ( const util::Optional< std::string > & ddns_conflict_resolution_mode )

inline

Sets new ib-ddns-conflict-resolution-mode.

Parameters

ddns_conflict_resolution_mode New value to use.

Definition at line 797 of file network.h.

References ddns_conflict_resolution_mode_.

◆ setDdnsGeneratedPrefix()

void isc::dhcp::Network::setDdnsGeneratedPrefix ( const util::Optional< std::string > & ddns_generated_prefix )

inline

Sets new ddns-generated-prefix.

Parameters

ddns_generated_prefix New value to use.

Definition at line 646 of file network.h.

References ddns_generated_prefix_.

◆ setDdnsOverrideClientUpdate()

void isc::dhcp::Network::setDdnsOverrideClientUpdate ( const util::Optional< bool > & ddns_override_client_update )

inline

Sets new ddns-override-client-update.

Parameters

ddns_override_client_update New value to use.

Definition at line 582 of file network.h.

References ddns_override_client_update_.

◆ setDdnsOverrideNoUpdate()

void isc::dhcp::Network::setDdnsOverrideNoUpdate ( const util::Optional< bool > & ddns_override_no_update )

inline

Sets new ddns-override-no-update.

Parameters

ddns_override_no_update New value to use.

Definition at line 565 of file network.h.

References ddns_override_no_update_.

◆ setDdnsQualifyingSuffix()

void isc::dhcp::Network::setDdnsQualifyingSuffix ( const util::Optional< std::string > & ddns_qualifying_suffix )

inline

Sets new ddns-qualifying-suffix.

Parameters

ddns_qualifying_suffix New value to use.

Definition at line 663 of file network.h.

References ddns_qualifying_suffix_.

◆ setDdnsReplaceClientNameMode()

void isc::dhcp::Network::setDdnsReplaceClientNameMode ( const util::Optional< D2ClientConfig::ReplaceClientNameMode > & ddns_replace_client_name_mode )

inline

Sets new ddns-replace-client-name-mode.

Parameters

ddns_replace_client_name_mode New value to use.

Definition at line 628 of file network.h.

References ddns_replace_client_name_mode_.

◆ setDdnsSendUpdates()

void isc::dhcp::Network::setDdnsSendUpdates ( const util::Optional< bool > & ddns_send_updates )

inline

Sets new ddns-send-updates.

Parameters

ddns_send_updates New value to use.

Definition at line 548 of file network.h.

References ddns_send_updates_.

◆ setDdnsTtlPercent()

void isc::dhcp::Network::setDdnsTtlPercent ( const util::Optional< double > & ddns_ttl_percent )

inline

Sets new ddns-ttl-percent.

Parameters

ddns_ttl_percent New value to use.

Definition at line 680 of file network.h.

References ddns_ttl_percent_.

◆ setDdnsUpdateOnRenew()

void isc::dhcp::Network::setDdnsUpdateOnRenew ( const util::Optional< bool > & ddns_update_on_renew )

inline

Sets new ddns-update-on-renew.

Parameters

ddns_update_on_renew New value to use.

Definition at line 778 of file network.h.

References ddns_update_on_renew_.

◆ setDefaultAllocatorType()

void isc::dhcp::Network::setDefaultAllocatorType ( const std::string & allocator_type )

inline

Sets a defalt allocator type.

Parameters

allocator_type a new default allocator type.

Definition at line 839 of file network.h.

References default_allocator_type_.

◆ setFetchGlobalsFn()

void isc::dhcp::Network::setFetchGlobalsFn ( FetchNetworkGlobalsFn fetch_globals_fn )

inline

Sets the optional callback function used to fetch globally configured parameters.

Parameters

fetch_globals_fn Pointer to the function.

Definition at line 235 of file network.h.

References fetch_globals_fn_.

◆ setHostnameCharReplacement()

void isc::dhcp::Network::setHostnameCharReplacement ( const util::Optional< std::string > & hostname_char_replacement )

inline

Sets new hostname-char-replacement.

Parameters

hostname_char_replacement New value to use.

Definition at line 710 of file network.h.

References hostname_char_replacement_.

◆ setHostnameCharSet()

void isc::dhcp::Network::setHostnameCharSet ( const util::Optional< std::string > & hostname_char_set )

inline

Sets new hostname-char-set.

Parameters

hostname_char_set New value to use.

Definition at line 695 of file network.h.

References hostname_char_set_.

◆ setIface()

void isc::dhcp::Network::setIface ( const util::Optional< std::string > & iface_name )

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.

Parameters

iface_name Interface name.

Definition at line 256 of file network.h.

References isc::util::Optional< T >::empty(), and iface_name_.

Here is the call graph for this function:

◆ setRelayInfo()

void isc::dhcp::Network::setRelayInfo ( const RelayInfo & relay )

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.

Parameters

relay structure that contains relay information

Definition at line 294 of file network.h.

References relay_.

◆ setReservationsGlobal()

void isc::dhcp::Network::setReservationsGlobal ( const util::Optional< bool > & reservations_global )

inline

Sets whether global reservations should be fetched.

Parameters

reservations_global new value of enabled/disabled.

Definition at line 434 of file network.h.

References reservations_global_.

◆ setReservationsInSubnet()

void isc::dhcp::Network::setReservationsInSubnet ( const util::Optional< bool > & reservations_in_subnet )

inline

Sets whether subnet reservations should be fetched.

Parameters

reservations_in_subnet new value of enabled/disabled.

Definition at line 452 of file network.h.

References reservations_in_subnet_.

◆ setReservationsOutOfPool()

void isc::dhcp::Network::setReservationsOutOfPool ( const util::Optional< bool > & reservations_out_of_pool )

inline

Sets whether only out-of-pool reservations are allowed.

Parameters

reservations_out_of_pool new value of enabled/disabled.

Definition at line 470 of file network.h.

References reservations_out_of_pool_.

◆ setStoreExtendedInfo()

void isc::dhcp::Network::setStoreExtendedInfo ( const util::Optional< bool > & store_extended_info )

inline

Sets new store-extended-info.

Parameters

store_extended_info New value to use.

Definition at line 728 of file network.h.

References store_extended_info_.

◆ setT1()

void isc::dhcp::Network::setT1 ( const isc::util::Triplet< uint32_t > & t1 )

inline

Sets new renew timer for a network.

Parameters

t1	New renew timer value in seconds.

Definition at line 401 of file network.h.

References t1_.

Referenced by isc::dhcp::Subnet4::Subnet4(), and isc::dhcp::Subnet6::Subnet6().

◆ setT1Percent()

void isc::dhcp::Network::setT1Percent ( const util::Optional< double > & t1_percent )

inline

Sets new percentage for calculating T1 (renew timer).

Parameters

t1_percent New percentage to use.

Definition at line 515 of file network.h.

References t1_percent_.

◆ setT2()

void isc::dhcp::Network::setT2 ( const isc::util::Triplet< uint32_t > & t2 )

inline

Sets new rebind timer for a network.

Parameters

t2	New rebind timer value in seconds.

Definition at line 416 of file network.h.

References t2_.

Referenced by isc::dhcp::Subnet4::Subnet4(), and isc::dhcp::Subnet6::Subnet6().

◆ setT2Percent()

void isc::dhcp::Network::setT2Percent ( const util::Optional< double > & t2_percent )

inline

Sets new percentage for calculating T2 (rebind timer).

Parameters

t2_percent New percentage to use.

Definition at line 531 of file network.h.

References t2_percent_.

◆ setValid()

void isc::dhcp::Network::setValid ( const isc::util::Triplet< uint32_t > & valid )

inline

Sets new valid lifetime for a network.

Parameters

valid New valid lifetime in seconds.

Definition at line 386 of file network.h.

References valid_.

Referenced by isc::dhcp::Subnet4::Subnet4(), and isc::dhcp::Subnet6::Subnet6().

◆ toElement()

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

virtual

Unparses network object.

Returns: A pointer to unparsed network configuration.

Implements isc::data::CfgToElement.

Reimplemented in isc::dhcp::Network4, isc::dhcp::Network6, isc::dhcp::SharedNetwork4, isc::dhcp::SharedNetwork6, isc::dhcp::Subnet, isc::dhcp::Subnet4, and isc::dhcp::Subnet6.

Definition at line 117 of file network.cc.

References allocator_type_, cache_max_age_, cache_threshold_, calculate_tee_times_, client_class_, isc::data::UserContext::contextToElement(), isc::data::Element::create(), isc::data::Element::createList(), isc::data::Element::createMap(), ddns_conflict_resolution_mode_, ddns_generated_prefix_, ddns_override_client_update_, ddns_override_no_update_, ddns_qualifying_suffix_, ddns_replace_client_name_mode_, ddns_send_updates_, ddns_ttl_percent_, ddns_update_on_renew_, isc::dhcp::ClientClasses::empty(), isc::util::Optional< T >::get(), isc::util::Triplet< T >::get(), getCfgOption(), isc::util::Triplet< T >::getMax(), isc::util::Triplet< T >::getMin(), getRelayAddresses(), getRequiredClasses(), hostname_char_replacement_, hostname_char_set_, iface_name_, reservations_global_, reservations_in_subnet_, reservations_out_of_pool_, store_extended_info_, t1_, t1_percent_, t2_, t2_percent_, isc::util::Optional< T >::unspecified(), and valid_.

Referenced by isc::dhcp::Network4::toElement(), and isc::dhcp::Network6::toElement().

Here is the call graph for this function:

Member Data Documentation

◆ allocator_type_

util::Optional<std::string> isc::dhcp::Network::allocator_type_

protected

Allocator used for IP address allocations.

Definition at line 1238 of file network.h.

Referenced by getAllocatorType(), setAllocatorType(), and toElement().

◆ cache_max_age_

util::Optional<uint32_t> isc::dhcp::Network::cache_max_age_

protected

Value in seconds to use as cache maximal age.

Definition at line 1226 of file network.h.

Referenced by getCacheMaxAge(), setCacheMaxAge(), and toElement().

◆ cache_threshold_

util::Optional<double> isc::dhcp::Network::cache_threshold_

protected

Percentage of the lease lifetime to use as cache threshold.

Definition at line 1223 of file network.h.

Referenced by getCacheThreshold(), setCacheThreshold(), and toElement().

◆ calculate_tee_times_

util::Optional<bool> isc::dhcp::Network::calculate_tee_times_

protected

Enables calculation of T1 and T2 timers.

Definition at line 1182 of file network.h.

Referenced by getCalculateTeeTimes(), setCalculateTeeTimes(), and toElement().

◆ cfg_option_

CfgOptionPtr isc::dhcp::Network::cfg_option_

protected

Pointer to the option data configuration for this subnet.

Definition at line 1179 of file network.h.

Referenced by getCfgOption(), and isc::dhcp::Network4::getServerId().

◆ client_class_

util::Optional<ClientClass> isc::dhcp::Network::client_class_

protected

Optional definition of a client class.

If defined, only clients belonging to that class will be allowed to use this particular network. The default value for this is an empty string, which means that any client is allowed, regardless of its class.

Definition at line 1148 of file network.h.

Referenced by allowClientClass(), clientSupported(), getClientClass(), and toElement().

◆ ddns_conflict_resolution_mode_

util::Optional<std::string> isc::dhcp::Network::ddns_conflict_resolution_mode_

protected

DDNS conflict resolution mode.

Definition at line 1232 of file network.h.

Referenced by getDdnsConflictResolutionMode(), setDdnsConflictResolutionMode(), and toElement().

◆ ddns_generated_prefix_

util::Optional<std::string> isc::dhcp::Network::ddns_generated_prefix_

protected

Prefix Kea should use when generating domain-names.

Definition at line 1205 of file network.h.

Referenced by getDdnsGeneratedPrefix(), setDdnsGeneratedPrefix(), and toElement().

◆ ddns_override_client_update_

util::Optional<bool> isc::dhcp::Network::ddns_override_client_update_

protected

Should Kea perform updates, even if client requested delegation.

Definition at line 1199 of file network.h.

Referenced by getDdnsOverrideClientUpdate(), setDdnsOverrideClientUpdate(), and toElement().

◆ ddns_override_no_update_

util::Optional<bool> isc::dhcp::Network::ddns_override_no_update_

protected

Should Kea perform updates, even if client requested no updates.

Overrides the client request for no updates via the N flag.

Definition at line 1196 of file network.h.

Referenced by getDdnsOverrideNoUpdate(), setDdnsOverrideNoUpdate(), and toElement().

◆ ddns_qualifying_suffix_

util::Optional<std::string> isc::dhcp::Network::ddns_qualifying_suffix_

protected

Suffix Kea should use when to qualify partial domain-names.

Definition at line 1208 of file network.h.

Referenced by getDdnsQualifyingSuffix(), setDdnsQualifyingSuffix(), and toElement().

◆ ddns_replace_client_name_mode_

util::Optional<D2ClientConfig::ReplaceClientNameMode> isc::dhcp::Network::ddns_replace_client_name_mode_

protected

How Kea should handle the domain-name supplied by the client.

Definition at line 1202 of file network.h.

Referenced by getDdnsReplaceClientNameMode(), setDdnsReplaceClientNameMode(), and toElement().

◆ ddns_send_updates_

util::Optional<bool> isc::dhcp::Network::ddns_send_updates_

protected

Should Kea perform DNS updates.

Used to provide scoped enabling and disabling of updates.

Definition at line 1192 of file network.h.

Referenced by getDdnsSendUpdates(), setDdnsSendUpdates(), and toElement().

◆ ddns_ttl_percent_

util::Optional<double> isc::dhcp::Network::ddns_ttl_percent_

protected

Percentage of the lease lifetime to use for DNS TTL.

Definition at line 1235 of file network.h.

Referenced by getDdnsTtlPercent(), setDdnsTtlPercent(), and toElement().

◆ ddns_update_on_renew_

util::Optional<bool> isc::dhcp::Network::ddns_update_on_renew_

protected

Should Kea perform updates when leases are extended.

Definition at line 1229 of file network.h.

Referenced by getDdnsUpdateOnRenew(), setDdnsUpdateOnRenew(), and toElement().

◆ default_allocator_type_

util::Optional<std::string> isc::dhcp::Network::default_allocator_type_

protected

Default allocator type.

This value is not configurable by the user. It is used by the configuration backend internally.

Definition at line 1244 of file network.h.

Referenced by getDefaultAllocatorType(), and setDefaultAllocatorType().

◆ fetch_globals_fn_

FetchNetworkGlobalsFn isc::dhcp::Network::fetch_globals_fn_

protected

Pointer to the optional callback used to fetch globally configured parameters inherited to the Network object.

Definition at line 1256 of file network.h.

Referenced by getFetchGlobalsFn(), getGlobalProperty(), hasFetchGlobalsFn(), and setFetchGlobalsFn().

◆ hostname_char_replacement_

util::Optional<std::string> isc::dhcp::Network::hostname_char_replacement_

protected

A string to replace invalid characters when scrubbing hostnames.

Meaningful only if hostname_char_set_ is not empty.

Definition at line 1216 of file network.h.

Referenced by getHostnameCharReplacement(), setHostnameCharReplacement(), and toElement().

◆ hostname_char_set_

util::Optional<std::string> isc::dhcp::Network::hostname_char_set_

protected

Regular expression describing invalid characters for client hostnames.

Definition at line 1212 of file network.h.

Referenced by getHostnameCharSet(), setHostnameCharSet(), and toElement().

◆ iface_name_

util::Optional<std::string> isc::dhcp::Network::iface_name_

protected

Holds interface name for which this network is selected.

Definition at line 1136 of file network.h.

Referenced by getIface(), setIface(), and toElement().

◆ parent_network_

WeakNetworkPtr isc::dhcp::Network::parent_network_

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 1252 of file network.h.

Referenced by getOptionProperty(), getProperty(), isc::dhcp::Subnet::getSharedNetwork(), and isc::dhcp::Subnet::setSharedNetwork().

◆ relay_

RelayInfo isc::dhcp::Network::relay_

protected

Relay information.

See RelayInfo for detailed description.

Definition at line 1141 of file network.h.

Referenced by addRelayAddress(), getRelayAddresses(), getRelayInfo(), hasRelayAddress(), hasRelays(), and setRelayInfo().

◆ required_classes_

ClientClasses isc::dhcp::Network::required_classes_

protected

Required classes.

If the network is selected these classes will be added to the incoming packet and their evaluation will be required.

Definition at line 1154 of file network.h.

Referenced by getRequiredClasses(), and requireClientClass().

◆ reservations_global_

util::Optional<bool> isc::dhcp::Network::reservations_global_

protected

Enables global reservations.

Definition at line 1166 of file network.h.

Referenced by getReservationsGlobal(), setReservationsGlobal(), and toElement().

◆ reservations_in_subnet_

util::Optional<bool> isc::dhcp::Network::reservations_in_subnet_

protected

Enables subnet reservations.

Definition at line 1169 of file network.h.

Referenced by getReservationsInSubnet(), setReservationsInSubnet(), and toElement().

◆ reservations_out_of_pool_

util::Optional<bool> isc::dhcp::Network::reservations_out_of_pool_

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.

Definition at line 1176 of file network.h.

Referenced by getReservationsOutOfPool(), setReservationsOutOfPool(), and toElement().

◆ store_extended_info_

util::Optional<bool> isc::dhcp::Network::store_extended_info_

protected

Should Kea store additional client query data (e.g.

relay-agent-info) on the lease.

Definition at line 1220 of file network.h.

Referenced by getStoreExtendedInfo(), setStoreExtendedInfo(), and toElement().

◆ t1_

isc::util::Triplet<uint32_t> isc::dhcp::Network::t1_

protected

a isc::util::Triplet (min/default/max) holding allowed renew timer values

Definition at line 1157 of file network.h.

Referenced by getT1(), setT1(), and toElement().

◆ t1_percent_

util::Optional<double> isc::dhcp::Network::t1_percent_

protected

Percentage of the lease lifetime to use when calculating T1 timer.

Definition at line 1185 of file network.h.

Referenced by getT1Percent(), setT1Percent(), and toElement().

◆ t2_

isc::util::Triplet<uint32_t> isc::dhcp::Network::t2_

protected

a isc::util::Triplet (min/default/max) holding allowed rebind timer values

Definition at line 1160 of file network.h.

Referenced by getT2(), setT2(), and toElement().

◆ t2_percent_

util::Optional<double> isc::dhcp::Network::t2_percent_

protected

Percentage of the lease lifetime to use when calculating T2 timer.

Definition at line 1188 of file network.h.

Referenced by getT2Percent(), setT2Percent(), and toElement().

◆ valid_

isc::util::Triplet<uint32_t> isc::dhcp::Network::valid_

protected

a isc::util::Triplet (min/default/max) holding allowed valid lifetime values

Definition at line 1163 of file network.h.

Referenced by getValid(), setValid(), and toElement().

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ RelayInfoPtr

Member Enumeration Documentation

◆ Inheritance

Constructor & Destructor Documentation

◆ Network()

◆ ~Network()

Member Function Documentation

◆ addRelayAddress()

◆ allowClientClass()

◆ clientSupported()

◆ getAllocatorType()

◆ getCacheMaxAge()

◆ getCacheThreshold()

◆ getCalculateTeeTimes()

◆ getCfgOption() [1/2]

◆ getCfgOption() [2/2]

◆ getClientClass()

◆ getDdnsConflictResolutionMode()

◆ getDdnsGeneratedPrefix()

◆ getDdnsOverrideClientUpdate()

◆ getDdnsOverrideNoUpdate()

◆ getDdnsQualifyingSuffix()

◆ getDdnsReplaceClientNameMode()

◆ getDdnsSendUpdates()

◆ getDdnsTtlPercent()

◆ getDdnsUpdateOnRenew()

◆ getDefaultAllocatorType()

◆ getFetchGlobalsFn()

◆ getGlobalProperty() [1/3]

◆ getGlobalProperty() [2/3]

◆ getGlobalProperty() [3/3]

◆ getHostnameCharReplacement()

◆ getHostnameCharSet()

◆ getIface()

◆ getLabel()

◆ getOptionProperty()

◆ getProperty()

◆ getRelayAddresses()

◆ getRelayInfo()

◆ getRequiredClasses()

◆ getReservationsGlobal()

◆ getReservationsInSubnet()

◆ getReservationsOutOfPool()

◆ getStoreExtendedInfo()

◆ getT1()

◆ getT1Percent()

◆ getT2()

◆ getT2Percent()

◆ getValid()

◆ hasFetchGlobalsFn()

◆ hasRelayAddress()

◆ hasRelays()

◆ requireClientClass()

◆ setAllocatorType()

◆ setCacheMaxAge()

◆ setCacheThreshold()

◆ setCalculateTeeTimes()

◆ setDdnsConflictResolutionMode()

◆ setDdnsGeneratedPrefix()

◆ setDdnsOverrideClientUpdate()

◆ setDdnsOverrideNoUpdate()

◆ setDdnsQualifyingSuffix()

◆ setDdnsReplaceClientNameMode()

◆ setDdnsSendUpdates()

◆ setDdnsTtlPercent()

◆ setDdnsUpdateOnRenew()

◆ setDefaultAllocatorType()

◆ setFetchGlobalsFn()

◆ setHostnameCharReplacement()

◆ setHostnameCharSet()

◆ setIface()

◆ setRelayInfo()