#include <pool.h>

Inheritance diagram for isc::dhcp::Pool:

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

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

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

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

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

Detailed Description

base class for Pool4 and Pool6

Stores information about pool of IPv4 or IPv6 addresses. That is a basic component of a configuration.

Definition at line 31 of file pool.h.

Constructor & Destructor Documentation

◆ ~Pool()

virtual isc::dhcp::Pool::~Pool ( )

inlinevirtual

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.

Definition at line 79 of file pool.h.

◆ Pool()

isc::dhcp::Pool::Pool	(	Lease::Type	type,
		const isc::asiolink::IOAddress &	first,
		const isc::asiolink::IOAddress &	last
	)

protected

protected constructor

This constructor is protected to prevent anyone from instantiating Pool class directly. Instances of Pool4 and Pool6 should be created instead.

Parameters

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

Member Function Documentation

◆ allowClientClass()

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

Sets the supported class to class class_name.

Parameters

class_name client class to be supported by this pool

Definition at line 36 of file pool.cc.

References client_class_.

Referenced by getCfgOption().

◆ clientSupported()

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

Checks whether this pool supports client that belongs to specified classes.

Todo:: : currently doing the same as network which needs improving.

Parameters

client_classes list of all classes the client belongs to

Returns: true if client can be supported, false otherwise

Definition at line 32 of file pool.cc.

References client_class_, and isc::dhcp::ClientClasses::contains().

Referenced by getCfgOption().

Here is the call graph for this function:

◆ getAllocationState()

AllocationStatePtr isc::dhcp::Pool::getAllocationState ( ) const

inline

Returns pool-specific allocation state.

The actual type of the state depends on the allocator type.

Returns: allocation state.

Definition at line 145 of file pool.h.

References allocation_state_.

◆ getCapacity()

uint64_t isc::dhcp::Pool::getCapacity ( ) const

inline

Returns the number of all leases in this pool.

Note that this is the upper bound, assuming that no leases are used and there are no host reservations. This is just a theoretical calculation.

Returns: number of possible leases in this pool

Definition at line 87 of file pool.h.

References capacity_.

◆ getCfgOption() [1/2]

CfgOptionPtr isc::dhcp::Pool::getCfgOption ( )

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

◆ getCfgOption() [2/2]

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

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

Here is the call graph for this function:

◆ getClientClass()

const ClientClass& isc::dhcp::Pool::getClientClass ( ) const

inline

returns the client class

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

Returns: client class client_class_

Definition at line 122 of file pool.h.

References client_class_.

Referenced by toElement().

◆ getFirstAddress()

const isc::asiolink::IOAddress& isc::dhcp::Pool::getFirstAddress ( ) const

inline

Returns the first address in a pool.

Returns: 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().

◆ getId()

uint32_t isc::dhcp::Pool::getId ( ) const

inline

returns Pool-id

Note: : PoolType enum was removed. Please use Lease::Type instead

Returns: pool-id value Pool-id is an unique value that can be used to identify a pool.

Definition at line 41 of file pool.h.

References id_.

◆ getLastAddress()

const isc::asiolink::IOAddress& isc::dhcp::Pool::getLastAddress ( ) const

inline

Returns the last address in a pool.

Returns: 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().

Here is the call graph for this function:

◆ getNextID()

static uint32_t isc::dhcp::Pool::getNextID ( )

inlinestaticprotected

returns the next unique Pool-ID

Returns: the next unique Pool-ID

Definition at line 186 of file pool.h.

◆ getPermutation()

IPRangePermutationPtr isc::dhcp::Pool::getPermutation ( ) const

inline

Returns pointer to the permutation associated with the pool.

Returns: Pointer to the address range permutation.

Definition at line 164 of file pool.h.

References permutation_, and Pool().

Here is the call graph for this function:

◆ getRequiredClasses()

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

inline

Returns classes which are required to be evaluated.

Definition at line 136 of file pool.h.

References required_classes_.

Referenced by toElement().

◆ getType()

Lease::Type isc::dhcp::Pool::getType ( ) const

inline

Returns pool type (v4, v6 non-temporary, v6 temp, v6 prefix)

Returns: returns pool type

Definition at line 65 of file pool.h.

References toText(), and type_.

Here is the call graph for this function:

◆ inRange()

bool isc::dhcp::Pool::inRange ( const isc::asiolink::IOAddress & addr ) const

Checks if a given address is in the range.

Returns: true, if the address is in pool

Definition at line 28 of file pool.cc.

References first_, and last_.

Referenced by getLastAddress().

◆ requireClientClass()

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

inline

Adds class class_name to classes required to be evaluated.

Parameters

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

Here is the call graph for this function:

◆ setAllocationState()

void isc::dhcp::Pool::setAllocationState ( const AllocationStatePtr & allocation_state )

inline

Sets pool-specific allocation state.

Parameters

allocation_state allocation state instance.

Definition at line 152 of file pool.h.

References allocation_state_, and toElement().

Here is the call graph for this function:

◆ toElement()

data::ElementPtr isc::dhcp::Pool::toElement ( ) const

virtual

Unparse a pool object.

Returns: A pointer to unparsed pool configuration.

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

Here is the call graph for this function:

◆ toText()

std::string isc::dhcp::Pool::toText ( ) const

virtual

returns textual representation of the pool

Returns: textual representation

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

Here is the call graph for this function:

Member Data Documentation

◆ allocation_state_

AllocationStatePtr isc::dhcp::Pool::allocation_state_

protected

Holds pool-specific allocation state.

Definition at line 230 of file pool.h.

Referenced by getAllocationState(), and setAllocationState().

◆ capacity_

uint64_t isc::dhcp::Pool::capacity_

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

◆ cfg_option_

CfgOptionPtr isc::dhcp::Pool::cfg_option_

protected

Pointer to the option data configuration for this pool.

Definition at line 214 of file pool.h.

Referenced by getCfgOption().

◆ client_class_

ClientClass isc::dhcp::Pool::client_class_

protected

Optional definition of a client class.

Network::client_class_

Definition at line 219 of file pool.h.

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

◆ first_

isc::asiolink::IOAddress isc::dhcp::Pool::first_

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

◆ id_

uint32_t isc::dhcp::Pool::id_

protected

pool-id

This ID is used to identify this specific pool.

Definition at line 194 of file pool.h.

Referenced by getId().

◆ last_

isc::asiolink::IOAddress isc::dhcp::Pool::last_

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

◆ permutation_

IPRangePermutationPtr isc::dhcp::Pool::permutation_

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

◆ required_classes_

ClientClasses isc::dhcp::Pool::required_classes_

protected

Required classes.

isc::dhcp::Network::required_classes_

Definition at line 224 of file pool.h.

Referenced by getRequiredClasses(), and requireClientClass().

◆ type_

Lease::Type isc::dhcp::Pool::type_

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

◆ user_context_

data::ConstElementPtr isc::dhcp::Pool::user_context_

protected

Pointer to the user context (may be NULL)

Definition at line 227 of file pool.h.

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

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~Pool()

◆ Pool()

Member Function Documentation

◆ allowClientClass()

◆ clientSupported()

◆ getAllocationState()

◆ getCapacity()

◆ getCfgOption() [1/2]

◆ getCfgOption() [2/2]

◆ getClientClass()

◆ getFirstAddress()

◆ getId()

◆ getLastAddress()

◆ getNextID()

◆ getPermutation()

◆ getRequiredClasses()

◆ getType()

◆ inRange()

◆ requireClientClass()

◆ setAllocationState()

◆ toElement()

◆ toText()

Member Data Documentation

◆ allocation_state_

◆ capacity_

◆ cfg_option_

◆ client_class_

◆ first_

◆ id_

◆ last_

◆ permutation_

◆ required_classes_

◆ type_

◆ user_context_