Represents option definitions used by the DHCP server. More...

#include <cfg_option_def.h>

Inheritance diagram for isc::dhcp::CfgOptionDef:

Public Member Functions
void	add (const OptionDefinitionPtr &def, const std::string &option_space)
	Add new option definition. More...

void	copyTo (CfgOptionDef &new_config) const
	Copies this configuration to a new configuration. More...

OptionDefinitionPtr	get (const std::string &option_space, const uint16_t option_code) const
	Return option definition for a particular option space and code. More...

OptionDefinitionPtr	get (const std::string &option_space, const std::string &option_name) const
	Return option definition for the particular option space and name. More...

OptionDefContainerPtr	getAll (const std::string &option_space) const
	Return option definitions for particular option space. More...

const OptionDefSpaceContainer &	getContainer () const
	Returns reference to container holding option definitions. More...

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

Methods and operators used for comparing objects.
bool	equals (const CfgOptionDef &other) const
	Check if configuration is equal to other configuration. More...

bool	operator== (const CfgOptionDef &other) const
	Equality operator. More...

bool	operator!= (const CfgOptionDef &other) const
	Inequality operator. More...

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

Detailed Description

Represents option definitions used by the DHCP server.

This class provides methods to add and retrieve option definitions specified by the administrator for the DHCP server. Option definitions specify formats of the options. This class doesn't hold information about the data being carried by the options.

Option definitions are grouped by option spaces. The option space is identified by the unique name which is specified as a string. The following names: "dhcp4" and "dhcp6" are reserved, though. They are names of option spaces used for standard top-level DHCPv4 and DHCPv6 options respectively.

Definition at line 30 of file cfg_option_def.h.

Member Function Documentation

◆ add()

void isc::dhcp::CfgOptionDef::add	(	const OptionDefinitionPtr &	def,
		const std::string &	option_space
	)

Add new option definition.

Parameters

def	option definition to be added.
option_space	name of the option space to add definition to.

Exceptions

isc::dhcp::DuplicateOptionDefinition	when the particular option definition already exists.
isc::dhcp::MalformedOptionDefinition	when the pointer to an option definition is NULL.
isc::BadValue	when the option space name is empty or when trying to override the standard option (in dhcp4 or dhcp6 option space).

Definition at line 79 of file cfg_option_def.cc.

References isc_throw.

Referenced by copyTo().

◆ copyTo()

void isc::dhcp::CfgOptionDef::copyTo ( CfgOptionDef & new_config ) const

Copies this configuration to a new configuration.

This method copies the option definitions stores in the configuration to an object passed as parameter. There are no shared objects or pointers between the original object and a copy.

Parameters

[out] new_config An object to which the configuration will be copied.

Definition at line 21 of file cfg_option_def.cc.

References add(), and isc::dhcp::OptionSpaceContainer< ContainerType, ItemType, Selector >::clearItems().

Here is the call graph for this function:

◆ equals()

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

Check if configuration is equal to other configuration.

Parameters

other An object holding configuration to compare to.

Returns: true if configurations are equal, false otherwise.

Definition at line 39 of file cfg_option_def.cc.

References get(), getAll(), and isc::dhcp::OptionSpaceContainer< ContainerType, ItemType, Selector >::getOptionSpaceNames().

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

Here is the call graph for this function:

◆ get() [1/2]

OptionDefinitionPtr isc::dhcp::CfgOptionDef::get	(	const std::string &	option_space,
		const uint16_t	option_code
	)		const

Return option definition for a particular option space and code.

Parameters

option_space	option space.
option_code	option code.

Returns: An option definition or NULL pointer if option definition has not been found.

Definition at line 112 of file cfg_option_def.cc.

Referenced by equals().

◆ get() [2/2]

OptionDefinitionPtr isc::dhcp::CfgOptionDef::get	(	const std::string &	option_space,
		const std::string &	option_name
	)		const

Return option definition for the particular option space and name.

Parameters

option_space	option space.
option_name	option name.

Returns: An option definition or NULL pointer if option definition has not been found.

Definition at line 134 of file cfg_option_def.cc.

◆ getAll()

OptionDefContainerPtr isc::dhcp::CfgOptionDef::getAll ( const std::string & option_space ) const

Return option definitions for particular option space.

Parameters

option_space option space.

Returns: Pointer to the collection of option definitions for the particular option space. The option collection is empty if no option exists for the option space specified.

Todo:: Does option space require any validation here?

Definition at line 106 of file cfg_option_def.cc.

Referenced by equals().

◆ getContainer()

const OptionDefSpaceContainer& isc::dhcp::CfgOptionDef::getContainer ( ) const

inline

Returns reference to container holding option definitions.

Definition at line 117 of file cfg_option_def.h.

◆ operator!=()

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

inline

Inequality operator.

Parameters

other An object holding configuration to compare to.

Returns: true if configurations are unequal, false otherwise.

Definition at line 67 of file cfg_option_def.h.

References equals().

Here is the call graph for this function:

◆ operator==()

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

inline

Equality operator.

Parameters

other An object holding configuration to compare to.

Returns: true if configurations are equal, false otherwise.

Definition at line 58 of file cfg_option_def.h.

References equals().

Here is the call graph for this function:

◆ toElement()

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

virtual

Unparse a configuration object.

Returns: a pointer to unparsed configuration

Implements isc::data::CfgToElement.

Definition at line 156 of file cfg_option_def.cc.

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

Here is the call graph for this function:

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ add()

◆ copyTo()

◆ equals()

◆ get() [1/2]

◆ get() [2/2]

◆ getAll()

◆ getContainer()

◆ operator!=()

◆ operator==()

◆ toElement()