Kea  2.3.4-git
isc::dhcp::Subnet4 Class Reference

A configuration holder for IPv4 subnet. More...

#include <subnet.h>

+ Inheritance diagram for isc::dhcp::Subnet4:

Public Member Functions

 Subnet4 (const isc::asiolink::IOAddress &prefix, uint8_t length, const util::Triplet< uint32_t > &t1, const util::Triplet< uint32_t > &t2, const util::Triplet< uint32_t > &valid_lifetime, const SubnetID id=0)
 Constructor with all parameters. More...
 
virtual bool clientSupported (const isc::dhcp::ClientClasses &client_classes) const
 Checks whether this subnet and parent shared network supports the client that belongs to specified classes. More...
 
Cfg4o6get4o6 ()
 Returns DHCP4o6 configuration parameters. More...
 
const Cfg4o6get4o6 () const
 Returns const DHCP4o6 configuration parameters. More...
 
Subnet4Ptr getNextSubnet (const Subnet4Ptr &first_subnet) const
 Returns next subnet within shared network. More...
 
Subnet4Ptr getNextSubnet (const Subnet4Ptr &first_subnet, const ClientClasses &client_classes) const
 Returns next subnet within shared network that matches client classes. More...
 
virtual data::ElementPtr toElement () const
 Unparse a subnet object. More...
 
- Public Member Functions inherited from isc::dhcp::Subnet
void addPool (const PoolPtr &pool)
 Adds a new pool for the subnet. More...
 
void delPools (Lease::Type type)
 Deletes all pools of specified type. More...
 
std::pair< isc::asiolink::IOAddress, uint8_t > get () const
 Returns subnet parameters (prefix and prefix length). More...
 
SubnetAllocationStatePtr getAllocationState () const
 Returns subnet-specific allocation state. More...
 
AllocatorPtr getAllocator (Lease::Type type) const
 Returns lease allocator instance. More...
 
PoolPtr getAnyPool (Lease::Type type)
 Returns a pool without any address specified. More...
 
SubnetID getID () const
 Returns unique ID for that subnet. More...
 
const PoolPtr getPool (Lease::Type type, const isc::asiolink::IOAddress &addr, bool anypool=true) const
 Returns a pool that specified address belongs to. More...
 
const PoolPtr getPool (Lease::Type type, const ClientClasses &client_classes, const isc::asiolink::IOAddress &addr) const
 Returns a pool that specified address belongs to with classes. More...
 
uint64_t getPoolCapacity (Lease::Type type) const
 Returns the number of possible leases for specified lease type. More...
 
uint64_t getPoolCapacity (Lease::Type type, const ClientClasses &client_classes) const
 Returns the number of possible leases for specified lease type allowed for a client which belongs to classes. More...
 
const PoolCollectiongetPools (Lease::Type type) const
 Returns all pools (const variant). More...
 
PoolCollectiongetPoolsWritable (Lease::Type type)
 Returns all pools (non-const variant). More...
 
template<typename SharedNetworkPtrType >
void getSharedNetwork (SharedNetworkPtrType &shared_network) const
 Retrieves pointer to a shared network associated with a subnet. More...
 
std::string getSharedNetworkName () const
 Returns shared network name. More...
 
bool inPool (Lease::Type type, const isc::asiolink::IOAddress &addr) const
 checks if the specified address is in pools. More...
 
bool inPool (Lease::Type type, const isc::asiolink::IOAddress &addr, const ClientClasses &client_classes) const
 checks if the specified address is in allowed pools. More...
 
bool inRange (const isc::asiolink::IOAddress &addr) const
 checks if specified address is in range. More...
 
void setAllocationState (const SubnetAllocationStatePtr &allocation_state)
 Sets subnet-specific allocation state. More...
 
void setAllocator (Lease::Type type, const AllocatorPtr &allocator)
 Sets new allocator instance. More...
 
void setSharedNetwork (const NetworkPtr &shared_network)
 Assigns shared network to a subnet. More...
 
void setSharedNetworkName (const std::string &shared_network_name)
 Sets new shared network name. More...
 
virtual std::string toText () const
 Returns textual representation of the subnet (e.g. 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...
 
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< ClientClassgetClientClass (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::ReplaceClientNameModegetDdnsReplaceClientNameMode (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 IOAddressListgetRelayAddresses () const
 Returns the list of relay addresses from the network's relay info. More...
 
const RelayInfogetRelayInfo () const
 Returns const reference to relay information. More...
 
const ClientClassesgetRequiredClasses () 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...
 
- 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< ServerTaggetServerTags () 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 &timestamp)
 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...
 
- Public Member Functions inherited from isc::dhcp::Network4
 Network4 ()
 Constructor. More...
 
util::Optional< bool > getAuthoritative (const Inheritance &inheritance=Inheritance::ALL) const
 Returns the flag indicating if requests for unknown IP addresses should be rejected with DHCPNAK instead of ignored. More...
 
util::Optional< std::string > getFilename (const Inheritance &inheritance=Inheritance::ALL) const
 Returns boot file name for this subnet. More...
 
util::Optional< bool > getMatchClientId (const Inheritance &inheritance=Inheritance::ALL) const
 Returns the flag indicating if the client identifiers should be used to identify the client's lease. More...
 
virtual asiolink::IOAddress getServerId () const
 Returns binary representation of the dhcp-server-identifier option (54). More...
 
util::Optional< asiolink::IOAddressgetSiaddr (const Inheritance &inheritance=Inheritance::ALL) const
 Returns siaddr for this network. More...
 
util::Optional< std::string > getSname (const Inheritance &inheritance=Inheritance::ALL) const
 Returns server hostname for this network. More...
 
void setAuthoritative (const util::Optional< bool > &authoritative)
 Sets the flag indicating if requests for unknown IP addresses should be rejected with DHCPNAK instead of ignored. More...
 
void setFilename (const util::Optional< std::string > &filename)
 Sets boot file name for the network. More...
 
void setMatchClientId (const util::Optional< bool > &match)
 Sets the flag indicating if the client identifier should be used to identify the client's lease. More...
 
void setSiaddr (const util::Optional< asiolink::IOAddress > &siaddr)
 Sets siaddr for the network. More...
 
void setSname (const util::Optional< std::string > &sname)
 Sets server hostname for the network. More...
 

Static Public Member Functions

static Subnet4Ptr create (const isc::asiolink::IOAddress &prefix, uint8_t length, const util::Triplet< uint32_t > &t1, const util::Triplet< uint32_t > &t2, const util::Triplet< uint32_t > &valid_lifetime, const SubnetID id=0)
 Factory function creating an instance of the Subnet4. More...
 
static std::pair< asiolink::IOAddress, uint8_t > parsePrefix (const std::string &prefix)
 Converts subnet prefix to a pair of prefix/length pair. More...
 
- Static Public Member Functions inherited from isc::dhcp::Subnet
static void resetSubnetID ()
 Resets subnet-id counter to its initial value (1). More...
 
- Static Public Member Functions inherited from isc::data::UserContext
static data::ElementPtr toElement (data::ConstElementPtr map)
 Copy an Element map. More...
 

Additional Inherited Members

- Public Types inherited from isc::dhcp::Network
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::RelayInfoRelayInfoPtr
 Pointer to the RelayInfo structure. More...
 
- Protected Member Functions inherited from isc::dhcp::Subnet
 Subnet (const isc::asiolink::IOAddress &prefix, uint8_t len, const SubnetID id)
 Protected constructor. More...
 
virtual ~Subnet ()
 virtual destructor. More...
 
bool poolOverlaps (const Lease::Type &pool_type, const PoolPtr &pool) const
 Checks if the specified pool overlaps with an existing pool. More...
 
uint64_t sumPoolCapacity (const PoolCollection &pools) const
 Returns a sum of possible leases in all pools. More...
 
uint64_t sumPoolCapacity (const PoolCollection &pools, const ClientClasses &client_classes) const
 Returns a sum of possible leases in all pools allowing classes. 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 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::IOAddressgetGlobalProperty (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...
 
- Static Protected Member Functions inherited from isc::dhcp::Subnet
static SubnetID generateNextID ()
 returns the next unique Subnet-ID. More...
 
static std::pair< asiolink::IOAddress, uint8_t > parsePrefixCommon (const std::string &prefix)
 Converts subnet prefix to a pair of prefix/length pair. More...
 
- Protected Attributes inherited from isc::dhcp::Subnet
SubnetAllocationStatePtr allocation_state_
 Holds subnet-specific allocation state. More...
 
std::map< Lease::Type, AllocatorPtrallocators_
 Lease allocators used by the subnet. More...
 
SubnetID id_
 subnet-id More...
 
PoolCollection pools_
 collection of IPv4 or non-temporary IPv6 pools in that subnet. More...
 
PoolCollection pools_pd_
 collection of IPv6 prefix pools in that subnet. More...
 
PoolCollection pools_ta_
 collection of IPv6 temporary address pools in that subnet. More...
 
isc::asiolink::IOAddress prefix_
 a prefix of the subnet. More...
 
uint8_t prefix_len_
 a prefix length of the subnet. More...
 
std::string shared_network_name_
 Shared network name. 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< ClientClassclient_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::ReplaceClientNameModeddns_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...
 
- Static Protected Attributes inherited from isc::dhcp::Subnet
static SubnetID static_id_ = 1
 keeps the subnet-id value. More...
 

Detailed Description

A configuration holder for IPv4 subnet.

This class represents an IPv4 subnet.

Note
Subnet and Network use virtual inheritance to avoid a diamond issue with UserContext

Definition at line 453 of file subnet.h.

Constructor & Destructor Documentation

◆ Subnet4()

isc::dhcp::Subnet4::Subnet4 ( const isc::asiolink::IOAddress prefix,
uint8_t  length,
const util::Triplet< uint32_t > &  t1,
const util::Triplet< uint32_t > &  t2,
const util::Triplet< uint32_t > &  valid_lifetime,
const SubnetID  id = 0 
)

Constructor with all parameters.

This constructor calls Subnet::Subnet, where subnet-id is generated.

Parameters
prefixSubnet4 prefix
lengthprefix length
t1renewal timer (in seconds)
t2rebind timer (in seconds)
valid_lifetimepreferred lifetime of leases (in seconds)
idarbitrary subnet id, default value of 0 triggers autogeneration of subnet id

Definition at line 186 of file subnet.cc.

References isc_throw, isc::asiolink::IOAddress::isV4(), isc::dhcp::Network::setT1(), isc::dhcp::Network::setT2(), isc::dhcp::Network::setValid(), and isc::asiolink::IOAddress::toText().

+ Here is the call graph for this function:

Member Function Documentation

◆ clientSupported()

bool isc::dhcp::Subnet4::clientSupported ( const isc::dhcp::ClientClasses client_classes) const
virtual

Checks whether this subnet and parent shared network supports the client that belongs to specified classes.

This method extends the Network::clientSupported method with additional checks whether shared network owning this class supports the client belonging to specified classes. If the class doesn't belong to a shared network this method only checks if the subnet supports specified classes.

Parameters
client_classesList of classes the client belongs to.
Returns
true if client can be supported, false otherwise.

Reimplemented from isc::dhcp::Network.

Definition at line 257 of file subnet.cc.

References isc::dhcp::Network::clientSupported(), and isc::dhcp::Subnet::getSharedNetwork().

+ Here is the call graph for this function:

◆ create()

Subnet4Ptr isc::dhcp::Subnet4::create ( const isc::asiolink::IOAddress prefix,
uint8_t  length,
const util::Triplet< uint32_t > &  t1,
const util::Triplet< uint32_t > &  t2,
const util::Triplet< uint32_t > &  valid_lifetime,
const SubnetID  id = 0 
)
static

Factory function creating an instance of the Subnet4.

This function should be used to create an instance of the subnet object within a hooks library in cases when the library may be unloaded before the object is destroyed. This ensures that the ownership of the object by the Kea process is retained.

It associates the subnet with the default, iterative, allocator. Therefore, using this function should be preferred over the constructor whenever the subnet needs a default allocator.

Parameters
prefixSubnet4 prefix
lengthprefix length
t1renewal timer (in seconds)
t2rebind timer (in seconds)
valid_lifetimepreferred lifetime of leases (in seconds)
idarbitrary subnet id, default value of 0 triggers autogeneration of subnet id
Returns
Pointer to the Subnet4 instance.

Definition at line 203 of file subnet.cc.

References isc::dhcp::Lease::TYPE_V4.

Referenced by isc::dhcp::Subnet4ConfigParser::initSubnet().

◆ get4o6() [1/2]

Cfg4o6& isc::dhcp::Subnet4::get4o6 ( )
inline

Returns DHCP4o6 configuration parameters.

This structure is always available. If the 4o6 is not enabled, its enabled_ field will be set to false.

Definition at line 547 of file subnet.h.

◆ get4o6() [2/2]

const Cfg4o6& isc::dhcp::Subnet4::get4o6 ( ) const
inline

Returns const DHCP4o6 configuration parameters.

This structure is always available. If the 4o6 is not enabled, its enabled_ field will be set to false.

Definition at line 555 of file subnet.h.

References isc::dhcp::Subnet::checkType(), isc::dhcp::Subnet::default_pool(), and isc::dhcp::Subnet::toElement().

+ Here is the call graph for this function:

◆ getNextSubnet() [1/2]

Subnet4Ptr isc::dhcp::Subnet4::getNextSubnet ( const Subnet4Ptr first_subnet) const

Returns next subnet within shared network.

If the current subnet doesn't belong to any shared network or if the next subnet is the same as first subnet (specified in the argument) a NULL pointer is returned.

Parameters
first_subnetPointer to the subnet from which iterations have started.
Returns
Pointer to the next subnet or NULL pointer if the next subnet is the first subnet or if the current subnet doesn't belong to a shared network.

Definition at line 218 of file subnet.cc.

References isc::dhcp::Subnet::getID(), and isc::dhcp::Subnet::getSharedNetwork().

+ Here is the call graph for this function:

◆ getNextSubnet() [2/2]

Subnet4Ptr isc::dhcp::Subnet4::getNextSubnet ( const Subnet4Ptr first_subnet,
const ClientClasses client_classes 
) const

Returns next subnet within shared network that matches client classes.

Parameters
first_subnetPointer to the subnet from which iterations have started.
client_classesList of classes that the client belongs to. The subnets not matching the classes aren't returned by this method.
Returns
Pointer to the next subnet or NULL pointer if the next subnet is the first subnet or if the current subnet doesn't belong to a shared network.

Definition at line 229 of file subnet.cc.

References isc::dhcp::Subnet::getID(), and isc::dhcp::Subnet::getSharedNetwork().

+ Here is the call graph for this function:

◆ parsePrefix()

std::pair< IOAddress, uint8_t > isc::dhcp::Subnet4::parsePrefix ( const std::string &  prefix)
static

Converts subnet prefix to a pair of prefix/length pair.

Parameters
prefixPrefix to be parsed.
Exceptions
BadValueif provided invalid IPv4 prefix.

Definition at line 699 of file subnet.cc.

References isc_throw, and isc::dhcp::Subnet::parsePrefixCommon().

+ Here is the call graph for this function:

◆ toElement()

data::ElementPtr isc::dhcp::Subnet4::toElement ( ) const
virtual

Unparse a subnet object.

Returns
A pointer to unparsed subnet configuration.

Reimplemented from isc::dhcp::Network4.

Definition at line 674 of file subnet.cc.

References isc::data::Element::createList(), isc::dhcp::Subnet::getPools(), isc::data::merge(), isc::dhcp::Cfg4o6::toElement(), isc::dhcp::Subnet::toElement(), isc::dhcp::Network4::toElement(), and isc::dhcp::Lease::TYPE_V4.

+ Here is the call graph for this function:

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