Pool information for IPv4 addresses. More...

#include <pool.h>

Inheritance diagram for isc::dhcp::Pool4:

Public Member Functions
	Pool4 (const isc::asiolink::IOAddress &first, const isc::asiolink::IOAddress &last)
	the constructor for Pool4 "min-max" style definition

	Pool4 (const isc::asiolink::IOAddress &prefix, uint8_t prefix_len)
	the constructor for Pool4 "prefix/len" style definition

virtual data::ElementPtr	toElement () const
	Unparse a Pool4 object.

Public Member Functions inherited from isc::dhcp::Pool
virtual	~Pool ()=default
	virtual destructor

void	allowClientClass (const ClientClass &class_name)
	Sets the supported class to class class_name.

bool	clientSupported (const ClientClasses &client_classes) const
	Checks whether this pool supports client that belongs to specified classes.

AllocationStatePtr	getAllocationState () const
	Returns pool-specific allocation state.

isc::util::uint128_t	getCapacity () const
	Returns the number of all leases in this pool.

CfgOptionPtr	getCfgOption ()
	Returns pointer to the option data configuration for this pool.

ConstCfgOptionPtr	getCfgOption () const
	Returns const pointer to the option data configuration for this pool.

const ClientClass &	getClientClass () const
	returns the client class

const isc::asiolink::IOAddress &	getFirstAddress () const
	Returns the first address in a pool.

uint64_t	getID () const
	Returns Pool-id.

const isc::asiolink::IOAddress &	getLastAddress () const
	Returns the last address in a pool.

const ClientClasses &	getRequiredClasses () const
	Returns classes which are required to be evaluated.

Lease::Type	getType () const
	Returns pool type (v4, v6 non-temporary, v6 temp, v6 prefix)

bool	inRange (const isc::asiolink::IOAddress &addr) const
	Checks if a given address is in the range.

void	requireClientClass (const ClientClass &class_name)
	Adds class class_name to classes required to be evaluated.

void	setAllocationState (const AllocationStatePtr &allocation_state)
	Sets pool-specific allocation state.

void	setID (const uint64_t id)
	Sets Pool-id.

virtual data::ElementPtr	toElement () const
	Unparse a pool object.

virtual std::string	toText () const
	returns textual representation of the pool

Public Member Functions inherited from isc::data::UserContext
void	contextToElement (data::ElementPtr map) const
	Merge unparse a user_context object.

data::ConstElementPtr	getContext () const
	Returns const pointer to the user context.

void	setContext (const data::ConstElementPtr &ctx)
	Sets user context.

Public Member Functions inherited from isc::data::CfgToElement
virtual	~CfgToElement ()
	Destructor.

virtual isc::data::ElementPtr	toElement () const =0
	Unparse a configuration object.

Static Public Member Functions
static Pool4Ptr	create (const isc::asiolink::IOAddress &first, const isc::asiolink::IOAddress &last)
	Factory function for creating an instance of the `Pool4`.

static Pool4Ptr	create (const isc::asiolink::IOAddress &prefix, uint8_t prefix_len)
	Factory function for creating an instance of the `Pool4`.

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

Additional Inherited Members
Protected Member Functions inherited from isc::dhcp::Pool
	Pool (Lease::Type type, const isc::asiolink::IOAddress &first, const isc::asiolink::IOAddress &last)
	protected constructor

Protected Attributes inherited from isc::dhcp::Pool
AllocationStatePtr	allocation_state_
	Holds pool-specific allocation state.

isc::util::uint128_t	capacity_
	Stores number of possible leases.

CfgOptionPtr	cfg_option_
	Pointer to the option data configuration for this pool.

ClientClass	client_class_
	Optional definition of a client class.

isc::asiolink::IOAddress	first_
	The first address in a pool.

uint64_t	id_
	pool-id

isc::asiolink::IOAddress	last_
	The last address in a pool.

ClientClasses	required_classes_
	Required classes.

Lease::Type	type_
	defines a lease type that will be served from this pool

data::ConstElementPtr	user_context_
	Pointer to the user context (may be NULL)

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

Detailed Description

Pool information for IPv4 addresses.

It holds information about pool4, i.e. a range of IPv4 address space that is configured for DHCP allocation.

Definition at line 240 of file pool.h.

Constructor & Destructor Documentation

◆ Pool4() [1/2]

isc::dhcp::Pool4::Pool4	(	const isc::asiolink::IOAddress &	first,
		const isc::asiolink::IOAddress &	last
	)

the constructor for Pool4 "min-max" style definition

Parameters

first	the first address in a pool
last	the last address in a pool

Definition at line 47 of file pool.cc.

References isc::asiolink::addrsInRange(), isc::dhcp::Pool::capacity_, isc_throw, and isc::asiolink::IOAddress::isV4().

Here is the call graph for this function:

◆ Pool4() [2/2]

isc::dhcp::Pool4::Pool4	(	const isc::asiolink::IOAddress &	prefix,
		uint8_t	prefix_len
	)

the constructor for Pool4 "prefix/len" style definition

Parameters

prefix	specifies prefix of the pool
prefix_len	specifies length of the prefix of the pool

Definition at line 66 of file pool.cc.

References isc::asiolink::addrsInRange(), isc::dhcp::Pool::capacity_, isc::asiolink::firstAddrInPrefix(), isc_throw, isc::asiolink::IOAddress::isV4(), isc::dhcp::Pool::last_, and isc::asiolink::lastAddrInPrefix().

Here is the call graph for this function:

Member Function Documentation

◆ create() [1/2]

Pool4Ptr isc::dhcp::Pool4::create	(	const isc::asiolink::IOAddress &	first,
		const isc::asiolink::IOAddress &	last
	)

static

Factory function for creating an instance of the Pool4.

This function should be used to create an instance of the pool 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.

Parameters

first	the first address in a pool
last	the last address in a pool

Returns: Pointer to the Pool4 instance.

Definition at line 97 of file pool.cc.

◆ create() [2/2]

Pool4Ptr isc::dhcp::Pool4::create	(	const isc::asiolink::IOAddress &	prefix,
		uint8_t	prefix_len
	)

static

Factory function for creating an instance of the Pool4.

This function should be used to create an instance of the pool 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.

Parameters

prefix	specifies prefix of the pool.
prefix_len	specifies length of the prefix of the pool.

Returns: Pointer to the Pool4 instance.

Definition at line 102 of file pool.cc.

◆ toElement()

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

virtual

Unparse a Pool4 object.

Returns: A pointer to unparsed Pool4 configuration.

Reimplemented from isc::dhcp::Pool.

Definition at line 142 of file pool.cc.

References isc::data::Element::create(), isc::dhcp::Pool::getFirstAddress(), isc::dhcp::Pool::getLastAddress(), isc::asiolink::prefixLengthFromRange(), isc::dhcp::Pool::toElement(), and isc::asiolink::IOAddress::toText().

Here is the call graph for this function:

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Pool4() [1/2]

◆ Pool4() [2/2]

Member Function Documentation

◆ create() [1/2]

◆ create() [2/2]

◆ toElement()