![]() |
Kea
2.5.2
|
base class for Pool4 and Pool6 More...
#include <pool.h>
Public Member Functions | |
virtual | ~Pool ()=default |
virtual destructor More... | |
void | allowClientClass (const ClientClass &class_name) |
Sets the supported class to class class_name. More... | |
bool | clientSupported (const ClientClasses &client_classes) const |
Checks whether this pool supports client that belongs to specified classes. More... | |
AllocationStatePtr | getAllocationState () const |
Returns pool-specific allocation state. More... | |
isc::util::uint128_t | getCapacity () const |
Returns the number of all leases in this pool. More... | |
CfgOptionPtr | getCfgOption () |
Returns pointer to the option data configuration for this pool. More... | |
ConstCfgOptionPtr | getCfgOption () const |
Returns const pointer to the option data configuration for this pool. More... | |
const ClientClass & | getClientClass () const |
returns the client class More... | |
const isc::asiolink::IOAddress & | getFirstAddress () const |
Returns the first address in a pool. More... | |
uint64_t | getID () const |
Returns Pool-id. More... | |
const isc::asiolink::IOAddress & | getLastAddress () const |
Returns the last address in a pool. More... | |
const ClientClasses & | getRequiredClasses () const |
Returns classes which are required to be evaluated. More... | |
Lease::Type | getType () const |
Returns pool type (v4, v6 non-temporary, v6 temp, v6 prefix) More... | |
bool | inRange (const isc::asiolink::IOAddress &addr) const |
Checks if a given address is in the range. More... | |
void | requireClientClass (const ClientClass &class_name) |
Adds class class_name to classes required to be evaluated. More... | |
void | setAllocationState (const AllocationStatePtr &allocation_state) |
Sets pool-specific allocation state. More... | |
void | setID (const uint64_t id) |
Sets Pool-id. More... | |
virtual data::ElementPtr | toElement () const |
Unparse a pool object. More... | |
virtual std::string | toText () const |
returns textual representation of the pool More... | |
![]() | |
void | contextToElement (data::ElementPtr map) const |
Merge unparse a user_context object. More... | |
data::ConstElementPtr | getContext () const |
Returns const pointer to the user context. More... | |
void | setContext (const data::ConstElementPtr &ctx) |
Sets user context. More... | |
![]() | |
virtual | ~CfgToElement () |
Destructor. More... | |
Protected Member Functions | |
Pool (Lease::Type type, const isc::asiolink::IOAddress &first, const isc::asiolink::IOAddress &last) | |
protected constructor More... | |
Protected Attributes | |
AllocationStatePtr | allocation_state_ |
Holds pool-specific allocation state. More... | |
isc::util::uint128_t | capacity_ |
Stores number of possible leases. More... | |
CfgOptionPtr | cfg_option_ |
Pointer to the option data configuration for this pool. More... | |
ClientClass | client_class_ |
Optional definition of a client class. More... | |
isc::asiolink::IOAddress | first_ |
The first address in a pool. More... | |
uint64_t | id_ |
pool-id More... | |
isc::asiolink::IOAddress | last_ |
The last address in a pool. More... | |
ClientClasses | required_classes_ |
Required classes. More... | |
Lease::Type | type_ |
defines a lease type that will be served from this pool More... | |
data::ConstElementPtr | user_context_ |
Pointer to the user context (may be NULL) More... | |
![]() | |
data::ConstElementPtr | user_context_ |
Pointer to the user context (may be NULL) More... | |
Additional Inherited Members | |
![]() | |
static data::ElementPtr | toElement (data::ConstElementPtr map) |
Copy an Element map. More... | |
base class for Pool4 and Pool6
Stores information about pool of IPv4 or IPv6 addresses. That is a basic component of a configuration.
|
virtualdefault |
virtual destructor
We need Pool to be a polymorphic class, so we could dynamic cast from PoolPtr to Pool6Ptr if we need to. A class becomes polymorphic, when there is at least one virtual method.
|
protected |
void isc::dhcp::Pool::allowClientClass | ( | const ClientClass & | class_name | ) |
Sets the supported class to class class_name.
class_name | client class to be supported by this pool |
Definition at line 35 of file pool.cc.
References client_class_.
bool isc::dhcp::Pool::clientSupported | ( | const ClientClasses & | client_classes | ) | const |
Checks whether this pool supports client that belongs to specified classes.
client_classes | list of all classes the client belongs to |
Definition at line 31 of file pool.cc.
References client_class_, and isc::dhcp::ClientClasses::contains().
|
inline |
Returns pool-specific allocation state.
The actual type of the state depends on the allocator type.
Definition at line 157 of file pool.h.
References allocation_state_.
|
inline |
|
inline |
Returns pointer to the option data configuration for this pool.
Definition at line 104 of file pool.h.
References cfg_option_.
Referenced by toElement().
|
inline |
Returns const pointer to the option data configuration for this pool.
Definition at line 110 of file pool.h.
References cfg_option_.
|
inline |
returns the client class
Definition at line 134 of file pool.h.
References client_class_.
Referenced by toElement().
|
inline |
Returns the first address in a pool.
Definition at line 61 of file pool.h.
References first_.
Referenced by isc::dhcp::Pool4::toElement(), and isc::dhcp::Pool6::toElement().
|
inline |
Returns Pool-id.
Pool-id is an unique value that can be used to identify a pool within a subnet or shared network.
Definition at line 44 of file pool.h.
References id_.
|
inline |
Returns the last address in a pool.
Definition at line 67 of file pool.h.
References last_.
Referenced by isc::dhcp::Pool4::toElement(), and isc::dhcp::Pool6::toElement().
|
inline |
Returns classes which are required to be evaluated.
Definition at line 148 of file pool.h.
References required_classes_.
Referenced by toElement().
|
inline |
bool isc::dhcp::Pool::inRange | ( | const isc::asiolink::IOAddress & | addr | ) | const |
|
inline |
Adds class class_name to classes required to be evaluated.
class_name | client class required to be evaluated |
Definition at line 141 of file pool.h.
References isc::dhcp::ClientClasses::contains(), isc::dhcp::ClientClasses::insert(), and required_classes_.
|
inline |
Sets pool-specific allocation state.
allocation_state | allocation state instance. |
Definition at line 164 of file pool.h.
References allocation_state_.
|
inline |
|
virtual |
Unparse a pool object.
Implements isc::data::CfgToElement.
Reimplemented in isc::dhcp::Pool6, and isc::dhcp::Pool4.
Definition at line 107 of file pool.cc.
References isc::dhcp::ClientClasses::cbegin(), isc::dhcp::ClientClasses::cend(), isc::data::UserContext::contextToElement(), isc::data::Element::create(), isc::data::Element::createList(), isc::data::Element::createMap(), isc::dhcp::ClientClasses::empty(), getCfgOption(), getClientClass(), getRequiredClasses(), and id_.
Referenced by isc::dhcp::Pool4::toElement(), and isc::dhcp::Pool6::toElement().
|
virtual |
returns textual representation of the pool
Reimplemented in isc::dhcp::Pool6.
Definition at line 40 of file pool.cc.
References first_, last_, type_, and isc::dhcp::Lease::typeToText().
|
protected |
Holds pool-specific allocation state.
Definition at line 228 of file pool.h.
Referenced by getAllocationState(), and setAllocationState().
|
protected |
Stores number of possible leases.
This could be calculated on the fly, but the calculations are somewhat involved, so it is more efficient to calculate it once and just store the result. Note that for very large pools, the number is capped at max value of uint64_t.
Definition at line 209 of file pool.h.
Referenced by isc::dhcp::Pool4::Pool4(), isc::dhcp::Pool6::Pool6(), and getCapacity().
|
protected |
Pointer to the option data configuration for this pool.
Definition at line 212 of file pool.h.
Referenced by getCfgOption().
|
protected |
Optional definition of a client class.
Definition at line 217 of file pool.h.
Referenced by allowClientClass(), clientSupported(), and getClientClass().
|
protected |
The first address in a pool.
Definition at line 195 of file pool.h.
Referenced by getFirstAddress(), inRange(), toText(), and isc::dhcp::Pool6::toText().
|
protected |
pool-id
This id is an unique value that can be used to identify a pool within a subnet or shared network.
Definition at line 192 of file pool.h.
Referenced by getID(), setID(), and toElement().
|
protected |
The last address in a pool.
Definition at line 198 of file pool.h.
Referenced by isc::dhcp::Pool4::Pool4(), getLastAddress(), inRange(), toText(), and isc::dhcp::Pool6::toText().
|
protected |
Required classes.
isc::dhcp::Network::required_classes_
Definition at line 222 of file pool.h.
Referenced by getRequiredClasses(), and requireClientClass().
|
protected |
defines a lease type that will be served from this pool
Definition at line 201 of file pool.h.
Referenced by getType(), isc::dhcp::Pool6::getType(), toText(), and isc::dhcp::Pool6::toText().
|
protected |