Container for storing client class names. More...

#include <classify.h>

Inheritance diagram for isc::dhcp::ClientClasses:

Public Types
typedef ClientClassContainer::const_iterator	const_iterator
	Type of iterators.

typedef ClientClassContainer::iterator	iterator

Public Member Functions
	ClientClasses ()
	Default constructor.

	ClientClasses (const ClientClasses &other)
	Copy constructor.

	ClientClasses (const std::string &class_names)
	Constructor from comma separated values.

virtual	~ClientClasses ()
	Destructor.

void	clear ()
	Clears containers.

bool	contains (const ClientClass &x) const
	returns if class x belongs to the defined classes

bool	empty () const
	Check if classes is empty.

bool	equals (const ClientClasses &other) const
	Compares two ClientClasses container for equality.

void	erase (const ClientClass &class_name)
	Erase element by name.

void	fromElement (isc::data::ConstElementPtr list)
	Sets contents from a ListElement.

void	insert (const ClientClass &class_name)
	Insert an element.

bool	intersects (const ClientClasses &cclasses) const
	returns whether this container has at least one class in common with a given container.

bool	operator!= (const ClientClasses &other) const
	Compares two ClientClasses container for inequality.

ClientClasses &	operator= (const ClientClasses &other)
	Assigns the contents of on container to another.

bool	operator== (const ClientClasses &other) const
	Compares two ClientClasses containers for equality.

size_t	size () const
	Returns the number of classes.

virtual isc::data::ElementPtr	toElement () const
	Returns all class names as an ElementPtr of type ListElement.

std::string	toText (const std::string &separator=", ") const
	Returns all class names as text.


const_iterator	cbegin () const
	Iterators to the first element.

const_iterator	begin () const

iterator	begin ()


const_iterator	cend () const
	Iterators to the past the end element.

const_iterator	end () const

iterator	end ()

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

Detailed Description

Container for storing client class names.

Both a list to iterate on it in insert order and unordered set of names for existence.

Definition at line 109 of file classify.h.

Member Typedef Documentation

◆ const_iterator

ClientClassContainer::const_iterator isc::dhcp::ClientClasses::const_iterator

Type of iterators.

Definition at line 113 of file classify.h.

◆ iterator

ClientClassContainer::iterator isc::dhcp::ClientClasses::iterator

Definition at line 114 of file classify.h.

Constructor & Destructor Documentation

◆ ClientClasses() [1/3]

isc::dhcp::ClientClasses::ClientClasses ( )

inline

Default constructor.

Definition at line 117 of file classify.h.

◆ ClientClasses() [2/3]

isc::dhcp::ClientClasses::ClientClasses ( const std::string & class_names )

Constructor from comma separated values.

Parameters

class_names A string containing a client classes separated with commas. The class names are trimmed before insertion to the set.

Definition at line 25 of file classify.cc.

References insert(), and isc::util::str::trim().

Here is the call graph for this function:

◆ ~ClientClasses()

virtual isc::dhcp::ClientClasses::~ClientClasses ( )

inlinevirtual

Destructor.

Definition at line 127 of file classify.h.

◆ ClientClasses() [3/3]

isc::dhcp::ClientClasses::ClientClasses ( const ClientClasses & other )

Copy constructor.

Parameters

other ClientClasses object to be copied.

Definition at line 39 of file classify.cc.

References insert().

Here is the call graph for this function:

Member Function Documentation

◆ begin() [1/2]

iterator isc::dhcp::ClientClasses::begin ( )

inline

Definition at line 191 of file classify.h.

◆ begin() [2/2]

const_iterator isc::dhcp::ClientClasses::begin ( ) const

inline

Definition at line 187 of file classify.h.

◆ cbegin()

const_iterator isc::dhcp::ClientClasses::cbegin ( ) const

inline

Iterators to the first element.

Definition at line 183 of file classify.h.

Referenced by equals().

◆ cend()

const_iterator isc::dhcp::ClientClasses::cend ( ) const

inline

Iterators to the past the end element.

Definition at line 198 of file classify.h.

Referenced by equals().

◆ clear()

void isc::dhcp::ClientClasses::clear ( )

inline

Clears containers.

Definition at line 226 of file classify.h.

Referenced by fromElement(), and operator=().

◆ contains()

bool isc::dhcp::ClientClasses::contains ( const ClientClass & x ) const

returns if class x belongs to the defined classes

Parameters

x	client class to be checked

Returns: true if x belongs to the classes

Definition at line 55 of file classify.cc.

Referenced by isc::dhcp::Network::addAdditionalClass(), isc::dhcp::Pkt::addAdditionalClass(), isc::dhcp::Pool::addAdditionalClass(), isc::dhcp::Pkt::addClass(), isc::dhcp::Pkt::addSubClass(), isc::dhcp::Network::allowClientClass(), isc::dhcp::Pool::allowClientClass(), isc::dhcp::Pkt::inClass(), and intersects().

◆ empty()

bool isc::dhcp::ClientClasses::empty ( ) const

inline

Check if classes is empty.

Definition at line 169 of file classify.h.

Referenced by isc::dhcp::OptionDescriptor::allowedForClientClasses(), isc::dhcp::Network::clientSupported(), isc::dhcp::Pool::clientSupported(), isc::dhcp::AllocEngine::getLifetimes6(), isc::dhcp::AllocEngine::getOfferLft(), isc::dhcp::AllocEngine::getValidLft(), isc::dhcp::Dhcpv4Srv::setFixedFields(), isc::dhcp::Network::toElement(), and isc::dhcp::Pool::toElement().

◆ end() [1/2]

iterator isc::dhcp::ClientClasses::end ( )

inline

Definition at line 206 of file classify.h.

◆ end() [2/2]

const_iterator isc::dhcp::ClientClasses::end ( ) const

inline

Definition at line 202 of file classify.h.

◆ equals()

bool isc::dhcp::ClientClasses::equals ( const ClientClasses & other ) const

Compares two ClientClasses container for equality.

Returns: True if the two containers are equal, false otherwise.

Definition at line 123 of file classify.cc.

References cbegin(), cend(), and size().

Referenced by operator!=(), and operator==().

Here is the call graph for this function:

◆ erase()

void isc::dhcp::ClientClasses::erase ( const ClientClass & class_name )

Erase element by name.

Parameters

class_name The name of the class to erase.

Definition at line 46 of file classify.cc.

◆ fromElement()

void isc::dhcp::ClientClasses::fromElement ( isc::data::ConstElementPtr list )

Sets contents from a ListElement.

Parameters

list	JSON list of classes from which to populate the container.

Exceptions

BadValue if the element is not a list or contents are invalid

Definition at line 104 of file classify.cc.

References clear(), insert(), isc_throw, isc::data::Element::list, and isc::data::Element::string.

Referenced by isc::dhcp::OptionDataParser::createOption().

Here is the call graph for this function:

◆ insert()

void isc::dhcp::ClientClasses::insert ( const ClientClass & class_name )

inline

Insert an element.

Parameters

class_name The name of the class to insert

Definition at line 159 of file classify.h.

Referenced by ClientClasses(), ClientClasses(), isc::dhcp::Network::addAdditionalClass(), isc::dhcp::Pkt::addAdditionalClass(), isc::dhcp::Pool::addAdditionalClass(), isc::dhcp::Pkt::addClass(), isc::dhcp::OptionDescriptor::addClientClass(), isc::dhcp::Pkt::addSubClass(), isc::dhcp::Network::allowClientClass(), isc::dhcp::Pool::allowClientClass(), isc::dhcp::Dhcpv4Srv::evaluateAdditionalClasses(), isc::dhcp::Dhcpv6Srv::evaluateAdditionalClasses(), fromElement(), and operator=().

◆ intersects()

bool isc::dhcp::ClientClasses::intersects ( const ClientClasses & cclasses ) const

returns whether this container has at least one class in common with a given container.

Parameters

cclasses list of classes to check for intersection with

Returns: true if this container has at least one class that is also in cclasses, false otherwise.

Definition at line 61 of file classify.cc.

References contains(), and size().

Referenced by isc::dhcp::OptionDescriptor::allowedForClientClasses(), isc::dhcp::Network::clientSupported(), and isc::dhcp::Pool::clientSupported().

Here is the call graph for this function:

◆ operator!=()

bool isc::dhcp::ClientClasses::operator!= ( const ClientClasses & other ) const

inline

Compares two ClientClasses container for inequality.

Returns: True if the two containers are not equal, false otherwise.

Definition at line 152 of file classify.h.

References equals().

Here is the call graph for this function:

◆ operator=()

ClientClasses & isc::dhcp::ClientClasses::operator= ( const ClientClasses & other )

Assigns the contents of on container to another.

Definition at line 128 of file classify.cc.

References clear(), and insert().

Here is the call graph for this function:

◆ operator==()

bool isc::dhcp::ClientClasses::operator== ( const ClientClasses & other ) const

inline

Compares two ClientClasses containers for equality.

Returns: True if the two containers are equal, false otherwise.

Definition at line 145 of file classify.h.

References equals().

Here is the call graph for this function:

◆ size()

size_t isc::dhcp::ClientClasses::size ( ) const

inline

Returns the number of classes.

Note: ; in C++ 11 list size complexity is constant so there is no advantage to use the set part.

Definition at line 177 of file classify.h.

Referenced by equals(), and intersects().

◆ toElement()

ElementPtr isc::dhcp::ClientClasses::toElement ( ) const

virtual

Returns all class names as an ElementPtr of type ListElement.

Returns: the list

Implements isc::data::CfgToElement.

Definition at line 95 of file classify.cc.

References isc::data::Element::create(), and isc::data::Element::createList().

Referenced by isc::dhcp::Network::toElement(), and isc::dhcp::Pool::toElement().

Here is the call graph for this function:

◆ toText()

std::string isc::dhcp::ClientClasses::toText ( const std::string & separator = ", " ) const

Returns all class names as text.

Parameters

separator Separator to be used between class names. The default separator comprises comma sign followed by space character.

Returns: the string representation of all classes

Definition at line 80 of file classify.cc.

Referenced by isc::dhcp::Dhcpv4Exchange::Dhcpv4Exchange(), and isc::dhcp::Dhcpv6Srv::initContext().

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

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

Constructor & Destructor Documentation

◆ ClientClasses() [1/3]

◆ ClientClasses() [2/3]

◆ ~ClientClasses()

◆ ClientClasses() [3/3]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ clear()

◆ contains()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ equals()

◆ erase()

◆ fromElement()

◆ insert()

◆ intersects()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ size()

◆ toElement()

◆ toText()