Base class representing a DHCP option definition. More...

#include <option_definition.h>

Inheritance diagram for isc::dhcp::OptionDefinition:

Public Types
typedef std::vector< OptionDataType >	RecordFieldsCollection
	List of fields within the record.

typedef std::vector< OptionDataType >::const_iterator	RecordFieldsConstIter
	Const iterator for record data fields.

Public Member Functions
	OptionDefinition (const std::string &name, const uint16_t code, const std::string &space, const OptionDataType type, const bool array_type=false)
	Constructor.

	OptionDefinition (const std::string &name, const uint16_t code, const std::string &space, const OptionDataType type, const char *encapsulated_space)
	Constructor.

	OptionDefinition (const std::string &name, const uint16_t code, const std::string &space, const std::string &type, const bool array_type=false)
	Constructor.

	OptionDefinition (const std::string &name, const uint16_t code, const std::string &space, const std::string &type, const char *encapsulated_space)
	Constructor.

Public Member Functions inherited from isc::data::StampedElement
	StampedElement ()
	Constructor.

void	delServerTag (const std::string &server_tag)
	Deletes server tag.

isc::data::ElementPtr	getMetadata () const
	Returns an object representing metadata to be returned with objects from the configuration backend.

std::set< ServerTag >	getServerTags () const
	Returns server tags.

bool	hasAllServerTag () const
	Checks if the element has 'all' server tag.

bool	hasServerTag (const ServerTag &server_tag) const
	Checks if the element has the given server tag.

void	setServerTag (const std::string &server_tag)
	Adds new server tag.

Public Member Functions inherited from isc::data::BaseStampedElement
	BaseStampedElement ()
	Constructor.

uint64_t	getId () const
	Returns element's database identifier.

boost::posix_time::ptime	getModificationTime () const
	Returns timestamp.

void	setId (const uint64_t id)
	Sets element's database identifier.

void	setModificationTime (const boost::posix_time::ptime &timestamp)
	Sets timestamp to the explicitly provided value.

void	updateModificationTime ()
	Sets timestamp to the current time.

Static Public Member Functions
static OptionDefinitionPtr	create (const std::string &name, const uint16_t code, const std::string &space, const OptionDataType type, const bool array_type=false)
	Factory function creating an instance of the `OptionDefinition`.

static OptionDefinitionPtr	create (const std::string &name, const uint16_t code, const std::string &space, const OptionDataType type, const char *encapsulated_space)
	Factory function creating an instance of the `OptionDefinition`.

static OptionDefinitionPtr	create (const std::string &name, const uint16_t code, const std::string &space, const std::string &type, const bool array_type=false)
	Factory function creating an instance of the `OptionDefinition`.

static OptionDefinitionPtr	create (const std::string &name, const uint16_t code, const std::string &space, const std::string &type, const char *encapsulated_space)
	Factory function creating an instance of the `OptionDefinition`.

Comparison functions and operators.
bool	equals (const OptionDefinition &other) const
	Check if option definition is equal to other.

bool	operator== (const OptionDefinition &other) const
	Equality operator.

bool	operator!= (const OptionDefinition &other) const
	Inequality operator.

void	addRecordField (const std::string &data_type_name)
	Adds data field to the record.

void	addRecordField (const OptionDataType data_type)
	Adds data field to the record.

bool	getArrayType () const
	Return array type indicator.

uint16_t	getCode () const
	Return option code.

std::string	getEncapsulatedSpace () const
	Return name of the encapsulated option space.

std::string	getName () const
	Return option name.

const RecordFieldsCollection &	getRecordFields () const
	Return list of record fields.

std::string	getOptionSpaceName () const
	Returns option space name.

OptionDataType	getType () const
	Return option data type.

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

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

void	contextToElement (data::ElementPtr map) const
	Merge unparse a user_context object.

void	validate () const
	Check if the option definition is valid.

OptionPtr	optionFactory (Option::Universe u, uint16_t type, OptionBufferConstIter begin, OptionBufferConstIter end, bool convenient_notation=false) const
	Option factory.

OptionPtr	optionFactory (Option::Universe u, uint16_t type, const OptionBuffer &buf=OptionBuffer()) const
	Option factory.

OptionPtr	optionFactory (Option::Universe u, uint16_t type, const std::vector< std::string > &values) const
	Option factory.

static OptionPtr	factoryAddrList4 (uint16_t type, OptionBufferConstIter begin, OptionBufferConstIter end)
	Factory to create option with address list.

static OptionPtr	factoryAddrList6 (uint16_t type, OptionBufferConstIter begin, OptionBufferConstIter end)
	Factory to create option with address list.

static OptionPtr	factoryEmpty (Option::Universe u, uint16_t type)
	Empty option factory.

static OptionPtr	factoryGeneric (Option::Universe u, uint16_t type, OptionBufferConstIter begin, OptionBufferConstIter end)
	Factory to create generic option.

static OptionPtr	factoryIA6 (uint16_t type, OptionBufferConstIter begin, OptionBufferConstIter end)
	Factory for IA-type of option.

static OptionPtr	factoryIAAddr6 (uint16_t type, OptionBufferConstIter begin, OptionBufferConstIter end)
	Factory for IAADDR-type of option.

static OptionPtr	factoryIAPrefix6 (uint16_t type, OptionBufferConstIter begin, OptionBufferConstIter end)
	Factory for IAPREFIX-type of option.

static OptionPtr	factoryOpaqueDataTuples (Option::Universe u, uint16_t type, OptionBufferConstIter begin, OptionBufferConstIter end)
	Factory to create option with tuple list.

static OptionPtr	factoryOpaqueDataTuples (Option::Universe u, uint16_t type, OptionBufferConstIter begin, OptionBufferConstIter end, OpaqueDataTuple::LengthFieldType length_field_type)
	Factory to create option with tuple list with explict tuple's length field type.

template<typename T >
static OptionPtr	factoryInteger (Option::Universe u, uint16_t type, const std::string &encapsulated_space, OptionBufferConstIter begin, OptionBufferConstIter end)
	Factory function to create option with integer value.

template<typename T >
static OptionPtr	factoryIntegerArray (Option::Universe u, uint16_t type, OptionBufferConstIter begin, OptionBufferConstIter end)
	Factory function to create option with array of integer values.

Additional Inherited Members
Protected Attributes inherited from isc::data::BaseStampedElement
uint64_t	id_
	Database identifier of the configuration element.

boost::posix_time::ptime	timestamp_
	Holds timestamp value.

Detailed Description

Base class representing a DHCP option definition.

This is a base class representing a DHCP option definition, which describes the format of the option. In particular, it defines:

option name,
option code,
option space,
data fields order and their types,
sub options space that the particular option encapsulates.

The option type specifies the data type(s) which an option conveys. If this is a single value the option type points to the data type of the value. For example, DHCPv6 option 8 comprises a two-byte option code, a two-byte option length and two-byte field that carries a uint16 value (RFC 8415 - http://ietf.org/rfc/rfc8415.txt). In such a case, the option type is defined as "uint16". Length and string tuples are a length on one (DHCPv4) or two (DHCPv6) bytes followed by a string of the given length.

When the option has a more complex structure, the option type may be defined as "array", "record" or even "array of records".

Array types should be used when the option contains multiple contiguous data values of the same type laid. For example, DHCPv6 option 6 includes multiple fields holding uint16 codes of requested DHCPv6 options (RFC 8415). Such an option can be represented with this class by setting the option type to "uint16" and the array indicator (array_type) to true. The number of elements in the array is effectively unlimited (although it is actually limited by the maximal DHCPv6 option length).

Should the option comprise data fields of different types, the "record" option type is used. In such cases the data field types within the record are specified using OptionDefinition::addRecordField.

When the OptionDefinition object has been successfully created, it can be queried to return the appropriate option factory function for the specified specified option format. There are a number of "standard" factory functions that cover well known (common) formats. If the particular format does not match any common format the generic factory function is returned.

The following data type strings are supported:

"empty" (option does not contain data fields)
"boolean"
"int8"
"int16"
"int32"
"uint8"
"uint16"
"uint32"
"ipv4-address" (IPv4 Address)
"ipv6-address" (IPv6 Address)
"ipv6-prefix" (IPv6 variable length prefix)
"psid" (PSID length / value)
"string"
"fqdn" (fully qualified name)
"tuple" (length and string)
"record" (set of data fields of different types)

Todo
Extend the comment to describe "generic factories".

Extend this class with more factory functions.

Derive from UserContext without breaking the multi index.

Definition at line 138 of file option_definition.h.

Member Typedef Documentation

◆ RecordFieldsCollection

std::vector<OptionDataType> isc::dhcp::OptionDefinition::RecordFieldsCollection

List of fields within the record.

Definition at line 142 of file option_definition.h.

◆ RecordFieldsConstIter

std::vector<OptionDataType>::const_iterator isc::dhcp::OptionDefinition::RecordFieldsConstIter

Const iterator for record data fields.

Definition at line 144 of file option_definition.h.

Constructor & Destructor Documentation

◆ OptionDefinition() [1/4]

isc::dhcp::OptionDefinition::OptionDefinition	(	const std::string &	name,
		const uint16_t	code,
		const std::string &	space,
		const std::string &	type,
		const bool	array_type = false )

explicit

Constructor.

Parameters

name	option name.
code	option code.
space	option space.
type	option data type as string.
array_type	array indicator, if true it indicates that the option fields are the array.

Definition at line 48 of file option_definition.cc.

References isc::dhcp::OptionDataTypeUtil::getDataType().

Here is the call graph for this function:

◆ OptionDefinition() [2/4]

isc::dhcp::OptionDefinition::OptionDefinition	(	const std::string &	name,
		const uint16_t	code,
		const std::string &	space,
		const OptionDataType	type,
		const bool	array_type = false )

explicit

Constructor.

Parameters

name	option name.
code	option code.
space	option space.
type	option data type.
array_type	array indicator, if true it indicates that the option fields are the array.

Definition at line 67 of file option_definition.cc.

◆ OptionDefinition() [3/4]

isc::dhcp::OptionDefinition::OptionDefinition	(	const std::string &	name,
		const uint16_t	code,
		const std::string &	space,
		const std::string &	type,
		const char *	encapsulated_space )

explicit

Constructor.

This constructor sets the name of the option space that is encapsulated by this option. The encapsulated option space identifies sub-options that are carried within this option. This constructor does not allow to set array indicator because options comprising an array of data fields must not be used with sub-options.

Parameters

name	option name.
code	option code.
space	option space.
type	option data type given as string.
encapsulated_space	name of the option space being encapsulated by this option.

Definition at line 80 of file option_definition.cc.

◆ OptionDefinition() [4/4]

isc::dhcp::OptionDefinition::OptionDefinition	(	const std::string &	name,
		const uint16_t	code,
		const std::string &	space,
		const OptionDataType	type,
		const char *	encapsulated_space )

explicit

Constructor.

This constructor sets the name of the option space that is encapsulated by this option. The encapsulated option space identifies sub-options that are carried within this option. This constructor does not allow to set array indicator because options comprising an array of data fields must not be used with sub-options.

Parameters

name	option name.
code	option code.
space	option space.
type	option data type.
encapsulated_space	name of the option space being encapsulated by this option.

Definition at line 98 of file option_definition.cc.

Member Function Documentation

◆ addRecordField() [1/2]

void isc::dhcp::OptionDefinition::addRecordField ( const OptionDataType data_type )

Adds data field to the record.

Parameters

data_type data type for the field.

Exceptions

isc::InvalidOperation	if option type is not set to RECORD_TYPE.
isc::BadValue	if specified invalid data type.

Definition at line 167 of file option_definition.cc.

References isc::dhcp::OptionDataTypeUtil::getDataTypeName(), isc_throw, isc::dhcp::OPT_ANY_ADDRESS_TYPE, isc::dhcp::OPT_EMPTY_TYPE, and isc::dhcp::OPT_RECORD_TYPE.

Here is the call graph for this function:

◆ addRecordField() [2/2]

void isc::dhcp::OptionDefinition::addRecordField ( const std::string & data_type_name )

Adds data field to the record.

Parameters

data_type_name name of the data type for the field.

Exceptions

isc::InvalidOperation	if option type is not set to RECORD_TYPE.
isc::BadValue	if specified invalid data type.

Definition at line 161 of file option_definition.cc.

References addRecordField(), and isc::dhcp::OptionDataTypeUtil::getDataType().

Referenced by addRecordField().

Here is the call graph for this function:

◆ contextToElement()

void isc::dhcp::OptionDefinition::contextToElement ( data::ElementPtr map ) const

inline

Merge unparse a user_context object.

Add user-context to map, but only if defined. Omit if it was not. Extract comment so it will be pretty-printed first.

Parameters

map	A pointer to map where the user context will be unparsed.

Definition at line 406 of file option_definition.h.

References isc::data::UserContext::contextToElement().

Here is the call graph for this function:

◆ create() [1/4]

OptionDefinitionPtr isc::dhcp::OptionDefinition::create	(	const std::string &	name,
		const uint16_t	code,
		const std::string &	space,
		const OptionDataType	type,
		const bool	array_type = false )

static

Factory function creating an instance of the OptionDefinition.

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

name	option name.
code	option code.
space	option space.
type	option data type.
array_type	array indicator, if true it indicates that the option fields are the array.

Returns: Pointer to the OptionDefinition instance.

Definition at line 123 of file option_definition.cc.

◆ create() [2/4]

OptionDefinitionPtr isc::dhcp::OptionDefinition::create	(	const std::string &	name,
		const uint16_t	code,
		const std::string &	space,
		const OptionDataType	type,
		const char *	encapsulated_space )

static

Factory function creating an instance of the OptionDefinition.

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

name	option name.
code	option code.
space	option space.
type	option data type.
encapsulated_space	name of the option space being encapsulated by this option.

Returns: Pointer to the OptionDefinition instance.

Definition at line 141 of file option_definition.cc.

◆ create() [3/4]

OptionDefinitionPtr isc::dhcp::OptionDefinition::create	(	const std::string &	name,
		const uint16_t	code,
		const std::string &	space,
		const std::string &	type,
		const bool	array_type = false )

static

Factory function creating an instance of the OptionDefinition.

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

name	option name.
code	option code.
space	option space.
type	option data type as string.
array_type	array indicator, if true it indicates that the option fields are the array.

Returns: Pointer to the OptionDefinition instance.

Definition at line 114 of file option_definition.cc.

◆ create() [4/4]

OptionDefinitionPtr isc::dhcp::OptionDefinition::create	(	const std::string &	name,
		const uint16_t	code,
		const std::string &	space,
		const std::string &	type,
		const char *	encapsulated_space )

static

Factory function creating an instance of the OptionDefinition.

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

name	option name.
code	option code.
space	option space.
type	option data type given as string.
encapsulated_space	name of the option space being encapsulated by this option.

Returns: Pointer to the OptionDefinition instance.

Definition at line 132 of file option_definition.cc.

◆ equals()

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

Check if option definition is equal to other.

Parameters

other Option definition to compare to.

Returns: true if two option definitions are equal, false otherwise.

Definition at line 150 of file option_definition.cc.

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

◆ factoryAddrList4()

OptionPtr isc::dhcp::OptionDefinition::factoryAddrList4	(	uint16_t	type,
		OptionBufferConstIter	begin,
		OptionBufferConstIter	end )

static

Factory to create option with address list.

Parameters

type	option type.
begin	iterator pointing to the beginning of the buffer with a list of IPv4 addresses.
end	iterator pointing to the end of the buffer with a list of IPv4 addresses.

Exceptions

isc::OutOfRange if length of the provided option buffer is not multiple of IPV4 address length.

Definition at line 739 of file option_definition.cc.

Referenced by optionFactory().

◆ factoryAddrList6()

OptionPtr isc::dhcp::OptionDefinition::factoryAddrList6	(	uint16_t	type,
		OptionBufferConstIter	begin,
		OptionBufferConstIter	end )

static

Factory to create option with address list.

Parameters

type	option type.
begin	iterator pointing to the beginning of the buffer with a list of IPv6 addresses.
end	iterator pointing to the end of the buffer with a list of IPv6 addresses.

Exceptions

isc::OutOfaRange if length of provided option buffer is not multiple of IPV6 address length.

Definition at line 748 of file option_definition.cc.

Referenced by optionFactory().

◆ factoryEmpty()

OptionPtr isc::dhcp::OptionDefinition::factoryEmpty	(	Option::Universe	u,
		uint16_t	type )

static

Empty option factory.

Parameters

u	universe (V6 or V4).
type	option type.

Definition at line 758 of file option_definition.cc.

Referenced by optionFactory().

◆ factoryGeneric()

OptionPtr isc::dhcp::OptionDefinition::factoryGeneric	(	Option::Universe	u,
		uint16_t	type,
		OptionBufferConstIter	begin,
		OptionBufferConstIter	end )

static

Factory to create generic option.

Parameters

u	universe (V6 or V4).
type	option type.
begin	iterator pointing to the beginning of the buffer.
end	iterator pointing to the end of the buffer.

Definition at line 764 of file option_definition.cc.

Referenced by optionFactory().

◆ factoryIA6()

OptionPtr isc::dhcp::OptionDefinition::factoryIA6	(	uint16_t	type,
		OptionBufferConstIter	begin,
		OptionBufferConstIter	end )

static

Factory for IA-type of option.

Parameters

type	option type.
begin	iterator pointing to the beginning of the buffer.
end	iterator pointing to the end of the buffer.

Exceptions

isc::OutOfRange if provided option buffer is too short or too long. Expected size is 12 bytes.

Definition at line 772 of file option_definition.cc.

References isc_throw, and isc::dhcp::Option6IA::OPTION6_IA_LEN.

◆ factoryIAAddr6()

OptionPtr isc::dhcp::OptionDefinition::factoryIAAddr6	(	uint16_t	type,
		OptionBufferConstIter	begin,
		OptionBufferConstIter	end )

static

Factory for IAADDR-type of option.

Parameters

type	option type.
begin	iterator pointing to the beginning of the buffer.
end	iterator pointing to the end of the buffer.

Exceptions

isc::OutOfRange if provided option buffer is too short or too long. Expected size is 24 bytes.

Definition at line 785 of file option_definition.cc.

References isc_throw, and isc::dhcp::Option6IAAddr::OPTION6_IAADDR_LEN.

◆ factoryIAPrefix6()

OptionPtr isc::dhcp::OptionDefinition::factoryIAPrefix6	(	uint16_t	type,
		OptionBufferConstIter	begin,
		OptionBufferConstIter	end )

static

Factory for IAPREFIX-type of option.

Parameters

type	option type.
begin	iterator pointing to the beginning of the buffer.
end	iterator pointing to the end of the buffer.

Exceptions

isc::OutOfRange if provided option buffer is too short. Expected minimum size is 25 bytes.

Definition at line 799 of file option_definition.cc.

References isc_throw, and isc::dhcp::Option6IAPrefix::OPTION6_IAPREFIX_LEN.

◆ factoryInteger()

template<typename T >

static OptionPtr isc::dhcp::OptionDefinition::factoryInteger	(	Option::Universe	u,
		uint16_t	type,
		const std::string &	encapsulated_space,
		OptionBufferConstIter	begin,
		OptionBufferConstIter	end )

inlinestatic

Factory function to create option with integer value.

Parameters

u	universe (V4 or V6).
type	option type.
encapsulated_space	An option space being encapsulated by the options created by this factory function. The options which belong to encapsulated option space are sub options of this option.
begin	iterator pointing to the beginning of the buffer.
end	iterator pointing to the end of the buffer.

Template Parameters

T	type of the data field (must be one of the uintX_t or intX_t).

Exceptions

isc::OutOfRange if provided option buffer length is invalid.

Definition at line 621 of file option_definition.h.

Referenced by optionFactory().

◆ factoryIntegerArray()

template<typename T >

static OptionPtr isc::dhcp::OptionDefinition::factoryIntegerArray	(	Option::Universe	u,
		uint16_t	type,
		OptionBufferConstIter	begin,
		OptionBufferConstIter	end )

inlinestatic

Factory function to create option with array of integer values.

Parameters

u	universe (V4 or V6).
type	option type.
begin	iterator pointing to the beginning of the buffer.
end	iterator pointing to the end of the buffer.

Template Parameters

T	type of the data field (must be one of the uintX_t or intX_t).

Exceptions

isc::OutOfRange if provided option buffer length is invalid.

Definition at line 641 of file option_definition.h.

Referenced by optionFactory().

◆ factoryOpaqueDataTuples() [1/2]

OptionPtr isc::dhcp::OptionDefinition::factoryOpaqueDataTuples	(	Option::Universe	u,
		uint16_t	type,
		OptionBufferConstIter	begin,
		OptionBufferConstIter	end )

static

Factory to create option with tuple list.

Parameters

u	option universe (V4 or V6).
type	option type.
begin	iterator pointing to the beginning of the buffer with a list of tuples.
end	iterator pointing to the end of the buffer with a list of tuples.

Returns: instance of the DHCP option.

Definition at line 813 of file option_definition.cc.

Referenced by optionFactory().

◆ factoryOpaqueDataTuples() [2/2]

OptionPtr isc::dhcp::OptionDefinition::factoryOpaqueDataTuples	(	Option::Universe	u,
		uint16_t	type,
		OptionBufferConstIter	begin,
		OptionBufferConstIter	end,
		OpaqueDataTuple::LengthFieldType	length_field_type )

static

Factory to create option with tuple list with explict tuple's length field type.

Parameters

u	option universe (V4 or V6).
type	option type.
begin	iterator pointing to the beginning of the buffer with a list of tuples.
end	iterator pointing to the end of the buffer with a list of tuples.
length_field_type	explicit tuple's length field type.

Returns: instance of the DHCP option.

Definition at line 824 of file option_definition.cc.

◆ getArrayType()

bool isc::dhcp::OptionDefinition::getArrayType ( ) const

inline

Return array type indicator.

The method returns the bool value to indicate whether the option is a single value or an array of values.

Returns: true if option comprises an array of values.

Definition at line 351 of file option_definition.h.

Referenced by isc::dhcp::OptionCustom::toText().

◆ getCode()

uint16_t isc::dhcp::OptionDefinition::getCode ( ) const

inline

Return option code.

Returns: option code.

Definition at line 356 of file option_definition.h.

Referenced by optionFactory().

◆ getContext()

data::ConstElementPtr isc::dhcp::OptionDefinition::getContext ( ) const

inline

Returns const pointer to the user context.

Definition at line 390 of file option_definition.h.

References isc::data::UserContext::getContext().

Here is the call graph for this function:

◆ getEncapsulatedSpace()

std::string isc::dhcp::OptionDefinition::getEncapsulatedSpace ( ) const

inline

Return name of the encapsulated option space.

Returns: name of the encapsulated option space.

Definition at line 361 of file option_definition.h.

Referenced by isc::dhcp::OptionCustom::OptionCustom(), isc::dhcp::OptionCustom::OptionCustom(), isc::dhcp::OptionCustom::OptionCustom(), and optionFactory().

◆ getName()

std::string isc::dhcp::OptionDefinition::getName ( ) const

inline

Return option name.

Returns: option name.

Definition at line 368 of file option_definition.h.

◆ getOptionSpaceName()

std::string isc::dhcp::OptionDefinition::getOptionSpaceName ( ) const

inline

Returns option space name.

Returns: Option space name.

Definition at line 380 of file option_definition.h.

◆ getRecordFields()

const RecordFieldsCollection & isc::dhcp::OptionDefinition::getRecordFields ( ) const

inline

Return list of record fields.

Returns: list of record fields.

Definition at line 373 of file option_definition.h.

Referenced by isc::dhcp::OptionCustom::addArrayDataField(), optionFactory(), isc::dhcp::OptionCustom::toText(), and validate().

◆ getType()

OptionDataType isc::dhcp::OptionDefinition::getType ( ) const

inline

Return option data type.

Returns: option data type.

Definition at line 387 of file option_definition.h.

Referenced by isc::dhcp::OptionCustom::addArrayDataField(), isc::dhcp::OptionCustom::addArrayDataField(), isc::dhcp::OptionCustom::addArrayDataField(), isc::dhcp::OptionCustom::addArrayDataField(), and isc::dhcp::OptionCustom::toText().

◆ operator!=()

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

inline

Inequality operator.

Parameters

other Option definition to compare to.

Returns: true if option definitions are not equal, false otherwise.

Definition at line 324 of file option_definition.h.

References equals().

Here is the call graph for this function:

◆ operator==()

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

inline

Equality operator.

Parameters

other Option definition to compare to.

Returns: true if two option definitions are equal, false otherwise.

Definition at line 315 of file option_definition.h.

References equals().

Here is the call graph for this function:

◆ optionFactory() [1/3]

OptionPtr isc::dhcp::OptionDefinition::optionFactory	(	Option::Universe	u,
		uint16_t	type,
		const OptionBuffer &	buf = OptionBuffer() ) const

Option factory.

This function creates an instance of DHCP option using whole provided buffer. This function may be used to create option which is to be sent in the outgoing packet.

Warning: calling this function on invalid option definition yields undefined behavior. Use validate to test that the option definition is valid.

Parameters

u	option universe (V4 or V6).
type	option type.
buf	option buffer.

Returns: instance of the DHCP option.

Exceptions

InvalidOptionValue if data for the option is invalid.

Definition at line 301 of file option_definition.cc.

References optionFactory().

Here is the call graph for this function:

◆ optionFactory() [2/3]

OptionPtr isc::dhcp::OptionDefinition::optionFactory	(	Option::Universe	u,
		uint16_t	type,
		const std::vector< std::string > &	values ) const

Option factory.

This function creates an instance of DHCP option using the vector of strings which carry data values for option data fields. The order of values in the vector corresponds to the order of data fields in the option. The supplied string values are cast to their actual data types which are determined based on the option definition. If cast fails due to type mismatch, an exception is thrown. This factory function can be used to create option instance when user specified option value in the comma separated values format in the configuration database. Provided string must be tokenized into the vector of string values and this vector can be supplied to this function.

Warning: calling this function on invalid option definition yields undefined behavior. Use validate to test that the option definition is valid.

Parameters

u	option universe (V4 or V6).
type	option type.
values	a vector of values to be used to set data for an option.

Returns: instance of the DHCP option.

Exceptions

InvalidOptionValue if data for the option is invalid.

Definition at line 307 of file option_definition.cc.

References getCode(), getRecordFields(), isc_throw, isc::dhcp::OPT_EMPTY_TYPE, isc::dhcp::OPT_INTERNAL_TYPE, isc::dhcp::OPT_RECORD_TYPE, isc::dhcp::OPT_STRING_TYPE, optionFactory(), and isc::util::str::trim().

Here is the call graph for this function:

◆ optionFactory() [3/3]

OptionPtr isc::dhcp::OptionDefinition::optionFactory	(	Option::Universe	u,
		uint16_t	type,
		OptionBufferConstIter	begin,
		OptionBufferConstIter	end,
		bool	convenient_notation = false ) const

Option factory.

This function creates an instance of DHCP option using provided chunk of buffer. This function may be used to create option which is to be sent in the outgoing packet.

Warning: calling this function on invalid option definition yields undefined behavior. Use validate to test that the option definition is valid.

Parameters

u	option universe (V4 or V6).
type	option type.
begin	beginning of the option buffer.
end	end of the option buffer.
convenient_notation	flag which indicates that the buffer contains option data as a string formatted in user-friendly, convenient way. The flag is propagated to the option constructor, so that the data could be parsed properly. Defaults to false.

Returns: instance of the DHCP option.

Exceptions

InvalidOptionValue if data for the option is invalid.

Definition at line 186 of file option_definition.cc.

Referenced by optionFactory(), and optionFactory().

Here is the call graph for this function:

◆ setContext()

void isc::dhcp::OptionDefinition::setContext ( const data::ConstElementPtr & ctx )

inline

Sets user context.

Parameters

ctx	user context to be stored.

Definition at line 396 of file option_definition.h.

References isc::data::UserContext::setContext().

Here is the call graph for this function:

◆ validate()

void isc::dhcp::OptionDefinition::validate ( ) const

Check if the option definition is valid.

Note that it is a responsibility of the code that created the OptionDefinition object to validate that it is valid. This function will not be called internally anywhere in this class to verify that the option definition is valid. Using invalid option definition to create an instance of the DHCP option leads to undefined behavior.

Exceptions

MalformedOptionDefinition option definition is invalid.

Definition at line 369 of file option_definition.cc.

References getRecordFields(), isc_throw, isc::dhcp::OPT_BINARY_TYPE, isc::dhcp::OPT_EMPTY_TYPE, isc::dhcp::OPT_INTERNAL_TYPE, isc::dhcp::OPT_RECORD_TYPE, isc::dhcp::OPT_STRING_TYPE, isc::dhcp::OPT_UNKNOWN_TYPE, and isc::dhcp::OptionSpace::validateName().

Here is the call graph for this function:

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

Public Types

Public Member Functions

Static Public Member Functions

Comparison functions and operators.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ RecordFieldsCollection

◆ RecordFieldsConstIter

Constructor & Destructor Documentation

◆ OptionDefinition() [1/4]

◆ OptionDefinition() [2/4]

◆ OptionDefinition() [3/4]

◆ OptionDefinition() [4/4]

Member Function Documentation

◆ addRecordField() [1/2]

◆ addRecordField() [2/2]

◆ contextToElement()

◆ create() [1/4]

◆ create() [2/4]

◆ create() [3/4]

◆ create() [4/4]

◆ equals()

◆ factoryAddrList4()

◆ factoryAddrList6()

◆ factoryEmpty()

◆ factoryGeneric()

◆ factoryIA6()

◆ factoryIAAddr6()

◆ factoryIAPrefix6()

◆ factoryInteger()

◆ factoryIntegerArray()

◆ factoryOpaqueDataTuples() [1/2]

◆ factoryOpaqueDataTuples() [2/2]

◆ getArrayType()

◆ getCode()

◆ getContext()

◆ getEncapsulatedSpace()

◆ getName()

◆ getOptionSpaceName()

◆ getRecordFields()

◆ getType()

◆ operator!=()

◆ operator==()

◆ optionFactory() [1/3]

◆ optionFactory() [2/3]

◆ optionFactory() [3/3]

◆ setContext()

◆ validate()