![]() |
Kea
2.3.5-git
|
base class for Pool4 and Pool6 More...
#include <pool.h>
Public Member Functions | |
virtual | ~Pool () |
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... | |
uint64_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... | |
uint32_t | getId () const |
returns Pool-id More... | |
const isc::asiolink::IOAddress & | getLastAddress () const |
Returns the last address in a pool. More... | |
IPRangePermutationPtr | getPermutation () const |
Returns pointer to the permutation associated with the 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... | |
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... | |
Static Protected Member Functions | |
static uint32_t | getNextID () |
returns the next unique Pool-ID More... | |
Protected Attributes | |
AllocationStatePtr | allocation_state_ |
Holds pool-specific allocation state. More... | |
uint64_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... | |
uint32_t | id_ |
pool-id More... | |
isc::asiolink::IOAddress | last_ |
The last address in a pool. More... | |
IPRangePermutationPtr | permutation_ |
Pointer to the permutation object. 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.
|
inlinevirtual |
|
protected |
protected constructor
This constructor is protected to prevent anyone from instantiating Pool class directly. Instances of Pool4 and Pool6 should be created instead.
type | type of lease that will be served from this pool |
first | first address of a range |
last | last address of a range |
Definition at line 21 of file pool.cc.
Referenced by getPermutation().
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 36 of file pool.cc.
References client_class_.
Referenced by getCfgOption().
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 32 of file pool.cc.
References client_class_, and isc::dhcp::ClientClasses::contains().
Referenced by getCfgOption().
|
inline |
Returns pool-specific allocation state.
The actual type of the state depends on the allocator type.
Definition at line 145 of file pool.h.
References allocation_state_.
|
inline |
|
inline |
Returns pointer to the option data configuration for this pool.
Definition at line 92 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 98 of file pool.h.
References allowClientClass(), cfg_option_, and clientSupported().
|
inline |
returns the client class
Definition at line 122 of file pool.h.
References client_class_.
Referenced by toElement().
|
inline |
Returns the first address in a pool.
Definition at line 48 of file pool.h.
References first_.
Referenced by isc::dhcp::Pool4::toElement(), and isc::dhcp::Pool6::toElement().
|
inline |
returns Pool-id
Definition at line 41 of file pool.h.
References id_.
|
inline |
Returns the last address in a pool.
Definition at line 54 of file pool.h.
References inRange(), and last_.
Referenced by isc::dhcp::Pool4::toElement(), and isc::dhcp::Pool6::toElement().
|
inlinestaticprotected |
|
inline |
Returns pointer to the permutation associated with the pool.
Definition at line 164 of file pool.h.
References permutation_, and Pool().
|
inline |
Returns classes which are required to be evaluated.
Definition at line 136 of file pool.h.
References required_classes_.
Referenced by toElement().
|
inline |
bool isc::dhcp::Pool::inRange | ( | const isc::asiolink::IOAddress & | addr | ) | const |
Checks if a given address is in the range.
Definition at line 28 of file pool.cc.
Referenced by getLastAddress().
|
inline |
Adds class class_name to classes required to be evaluated.
class_name | client class required to be evaluated |
Definition at line 129 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 152 of file pool.h.
References allocation_state_, and toElement().
|
virtual |
Unparse a pool object.
Implements isc::data::CfgToElement.
Reimplemented in isc::dhcp::Pool6, and isc::dhcp::Pool4.
Definition at line 108 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(), and getRequiredClasses().
Referenced by isc::dhcp::Pool6::getPrefixExcludeOption(), setAllocationState(), isc::dhcp::Pool4::toElement(), and isc::dhcp::Pool6::toElement().
|
virtual |
returns textual representation of the pool
Reimplemented in isc::dhcp::Pool6.
Definition at line 41 of file pool.cc.
References first_, last_, type_, and isc::dhcp::Lease::typeToText().
Referenced by isc::dhcp::Pool6::getPrefixExcludeOption(), and getType().
|
protected |
Holds pool-specific allocation state.
Definition at line 230 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 211 of file pool.h.
Referenced by isc::dhcp::Pool6::create(), getCapacity(), isc::dhcp::Pool4::Pool4(), and isc::dhcp::Pool6::Pool6().
|
protected |
Pointer to the option data configuration for this pool.
Definition at line 214 of file pool.h.
Referenced by getCfgOption().
|
protected |
Optional definition of a client class.
Definition at line 219 of file pool.h.
Referenced by allowClientClass(), clientSupported(), and getClientClass().
|
protected |
The first address in a pool.
Definition at line 197 of file pool.h.
Referenced by getFirstAddress(), inRange(), toText(), and isc::dhcp::Pool6::toText().
|
protected |
|
protected |
The last address in a pool.
Definition at line 200 of file pool.h.
Referenced by isc::dhcp::Pool6::create(), getLastAddress(), inRange(), isc::dhcp::Pool4::Pool4(), toText(), and isc::dhcp::Pool6::toText().
|
protected |
Pointer to the permutation object.
It may be initialized for some pools to provide address or delegated prefix randomization capabilities.
Definition at line 236 of file pool.h.
Referenced by getPermutation().
|
protected |
Required classes.
isc::dhcp::Network::required_classes_
Definition at line 224 of file pool.h.
Referenced by getRequiredClasses(), and requireClientClass().
|
protected |
defines a lease type that will be served from this pool
Definition at line 203 of file pool.h.
Referenced by getType(), isc::dhcp::Pool6::getType(), toText(), and isc::dhcp::Pool6::toText().
|
protected |