![]() |
Kea 2.2.0
|
Specialization of the Network object for DHCPv6 case. More...
#include <network.h>
Inheritance diagram for isc::dhcp::Network6:Public Member Functions | |
| Network6 () | |
| Constructor. More... | |
| OptionPtr | getInterfaceId (const Inheritance &inheritance=Inheritance::ALL) const |
| Returns interface-id value (if specified) More... | |
| isc::util::Triplet< uint32_t > | getPreferred (const Inheritance &inheritance=Inheritance::ALL) const |
| Returns preferred lifetime (in seconds) More... | |
| util::Optional< bool > | getRapidCommit (const Inheritance &inheritance=Inheritance::ALL) const |
| Returns boolean value indicating that the Rapid Commit option is supported or unsupported for the subnet. More... | |
| void | setInterfaceId (const OptionPtr &ifaceid) |
| sets interface-id option (if defined) More... | |
| void | setPreferred (const isc::util::Triplet< uint32_t > &preferred) |
| Sets new preferred lifetime for a network. More... | |
| void | setRapidCommit (const util::Optional< bool > &rapid_commit) |
| Enables or disables Rapid Commit option support for the subnet. More... | |
| virtual data::ElementPtr | toElement () const |
| Unparses network object. More... | |
Public Member Functions inherited from isc::dhcp::Network | |
| 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< 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 | 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... | |
Public Member Functions inherited from isc::data::StampedElement | |
| 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... | |
Public Member Functions inherited from isc::data::BaseStampedElement | |
| 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... | |
Public Member Functions inherited from isc::data::UserContext | |
| 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... | |
Public Member Functions inherited from isc::data::CfgToElement | |
| virtual | ~CfgToElement () |
| Destructor. More... | |
| virtual isc::data::ElementPtr | toElement () const =0 |
| Unparse a configuration object. More... | |
Additional Inherited Members | |
Public Types inherited from isc::dhcp::Network | |
| 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. More... | |
Static Public Member Functions inherited from isc::data::UserContext | |
| static data::ElementPtr | toElement (data::ConstElementPtr map) |
| Copy an Element map. More... | |
Protected Member Functions inherited from isc::dhcp::Network | |
| FetchNetworkGlobalsFn | getFetchGlobalsFn () const |
| Gets the optional callback function used to fetch globally configured parameters. 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... | |
| 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... | |
| 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 inherited from isc::dhcp::Network | |
| 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... | |
Protected Attributes inherited from isc::data::BaseStampedElement | |
| uint64_t | id_ |
| Database identifier of the configuration element. More... | |
| boost::posix_time::ptime | timestamp_ |
| Holds timestamp value. More... | |
Protected Attributes inherited from isc::data::UserContext | |
| data::ConstElementPtr | user_context_ |
| Pointer to the user context (may be NULL) More... | |
|
inline |
Returns interface-id value (if specified)
| inheritance | inheritance mode to be used. |
Definition at line 1315 of file network.h.
References getInterfaceId().
Referenced by getInterfaceId().
Here is the call graph for this function:
|
inline |
Returns preferred lifetime (in seconds)
| inheritance | inheritance mode to be used. |
Definition at line 1296 of file network.h.
References getPreferred(), isc::dhcp::CfgGlobals::MAX_PREFERRED_LIFETIME, isc::dhcp::CfgGlobals::MIN_PREFERRED_LIFETIME, and isc::dhcp::CfgGlobals::PREFERRED_LIFETIME.
Referenced by getPreferred(), and isc::dhcp::Subnet6ConfigParser::initSubnet().
Here is the call graph for this function:
|
inline |
Returns boolean value indicating that the Rapid Commit option is supported or unsupported for the subnet.
| inheritance | inheritance mode to be used. |
Definition at line 1335 of file network.h.
References getRapidCommit().
Referenced by getRapidCommit(), and isc::dhcp::Subnet6ConfigParser::initSubnet().
Here is the call graph for this function:
|
inline |
sets interface-id option (if defined)
| ifaceid | pointer to interface-id option |
Definition at line 1323 of file network.h.
Referenced by isc::dhcp::Subnet6ConfigParser::initSubnet().
|
inline |
Sets new preferred lifetime for a network.
| preferred | New preferred lifetime in seconds. |
Definition at line 1307 of file network.h.
Referenced by isc::dhcp::Subnet6::Subnet6().
|
inline |
Enables or disables Rapid Commit option support for the subnet.
| rapid_commit | A boolean value indicating that the Rapid Commit option support is enabled (if true), or disabled (if false). |
Definition at line 1345 of file network.h.
Referenced by isc::dhcp::Subnet6ConfigParser::initSubnet().
|
virtual |
Unparses network object.
Reimplemented from isc::dhcp::Network.
Reimplemented in isc::dhcp::SharedNetwork6, and isc::dhcp::Subnet6.
Definition at line 344 of file network.cc.
References isc::data::Element::create(), and isc::dhcp::Network::toElement().
Referenced by isc::dhcp::SharedNetwork6::toElement(), and isc::dhcp::Subnet6::toElement().
Here is the call graph for this function: