This class represents vendor-specific information option. More...

#include <option_vendor.h>

Inheritance diagram for isc::dhcp::OptionVendor:

Public Member Functions
	OptionVendor (Option::Universe u, const uint32_t vendor_id)
	Constructor.

	OptionVendor (Option::Universe u, OptionBufferConstIter begin, OptionBufferConstIter end)
	Constructor.

OptionPtr	clone () const
	Copies this option and returns a pointer to the copy.

uint32_t	getVendorId () const
	Returns enterprise identifier.

virtual uint16_t	len () const
	returns complete length of option

virtual void	pack (isc::util::OutputBuffer &buf, bool check=true) const
	Writes option in wire-format to buf, returns pointer to first unused byte after stored option.

void	setVendorId (const uint32_t vendor_id)
	Sets enterprise identifier.

virtual std::string	toText (int indent=0) const
	Returns the option in the textual format.

virtual void	unpack (OptionBufferConstIter begin, OptionBufferConstIter end)
	Parses received buffer.

Public Member Functions inherited from isc::dhcp::Option
	Option (const Option &source)
	Copy constructor.

	Option (Universe u, uint16_t type)
	ctor, used for options constructed, usually during transmission

	Option (Universe u, uint16_t type, const OptionBuffer &data)
	Constructor, used for received options.

	Option (Universe u, uint16_t type, OptionBufferConstIter first, OptionBufferConstIter last)
	Constructor, used for received options.

virtual	~Option ()
	just to force that every option has virtual dtor

void	addOption (OptionPtr opt)
	Adds a sub-option.

bool	delOption (uint16_t type)
	Attempts to delete first suboption of requested type.

virtual bool	equals (const Option &other) const
	Checks if two options are equal.

bool	equals (const OptionPtr &other) const
	Checks if options are equal.

virtual const OptionBuffer &	getData () const
	Returns pointer to actual data.

std::string	getEncapsulatedSpace () const
	Returns the name of the option space encapsulated by this option.

virtual uint16_t	getHeaderLen () const
	Returns length of header (2 for v4, 4 for v6)

OptionCollection &	getMutableOptions ()
	Returns all encapsulated options.

OptionPtr	getOption (uint16_t type) const
	Returns shared_ptr to suboption of specific type.

const OptionCollection &	getOptions () const
	Returns all encapsulated options.

void	getOptionsCopy (OptionCollection &options_copy) const
	Performs deep copy of suboptions.

uint16_t	getType () const
	Returns option type (0-255 for DHCPv4, 0-65535 for DHCPv6)

uint16_t	getUint16 () const
	Returns content of first word.

uint32_t	getUint32 () const
	Returns content of first double word.

uint8_t	getUint8 () const
	Returns content of first byte.

Universe	getUniverse () const
	returns option universe (V4 or V6)

Option &	operator= (const Option &rhs)
	Assignment operator.

template<typename InputIterator >
void	setData (InputIterator first, InputIterator last)
	Sets content of this option from buffer.

void	setEncapsulatedSpace (const std::string &encapsulated_space)
	Sets the name of the option space encapsulated by this option.

void	setUint16 (uint16_t value)
	Sets content of this option to a single uint16 value.

void	setUint32 (uint32_t value)
	Sets content of this option to a single uint32 value.

void	setUint8 (uint8_t value)
	Sets content of this option to a single uint8 value.

virtual std::vector< uint8_t >	toBinary (const bool include_header=false) const
	Returns binary representation of the option.

virtual std::string	toHexString (const bool include_header=false) const
	Returns string containing hexadecimal representation of option.

virtual std::string	toString () const
	Returns string representation of the value.

virtual bool	valid () const
	returns if option is valid (e.g.

Additional Inherited Members
Public Types inherited from isc::dhcp::Option
typedef OptionPtr	Factory(Option::Universe u, uint16_t type, const OptionBuffer &buf)
	a factory function prototype

enum	Universe { V4 , V6 }
	defines option universe DHCPv4 or DHCPv6 More...

Static Public Member Functions inherited from isc::dhcp::Option
static OptionPtr	create (Universe u, uint16_t type)
	Factory function creating an instance of the `Option`.

static OptionPtr	create (Universe u, uint16_t type, const OptionBuffer &data)
	Factory function creating an instance of the `Option`.

static OptionPtr	factory (Option::Universe u, uint16_t type)
	Factory function to create instance of option.

static OptionPtr	factory (Option::Universe u, uint16_t type, const OptionBuffer &buf)
	Factory function to create instance of option.

Static Public Attributes inherited from isc::dhcp::Option
static bool	lenient_parsing_
	Governs whether options should be parsed less strictly.

static const size_t	OPTION4_HDR_LEN = 2
	length of the usual DHCPv4 option header (there are exceptions)

static const size_t	OPTION6_HDR_LEN = 4
	length of any DHCPv6 option header

Protected Member Functions inherited from isc::dhcp::Option
void	check () const
	A protected method used for option correctness.

template<typename OptionType >
OptionPtr	cloneInternal () const
	Copies this option and returns a pointer to the copy.

std::string	headerToText (const int indent=0, const std::string &type_name="") const
	Returns option header in the textual format.

void	packHeader (isc::util::OutputBuffer &buf, bool check=true) const
	Store option's header in a buffer.

void	packOptions (isc::util::OutputBuffer &buf, bool check=true) const
	Store sub options in a buffer.

std::string	suboptionsToText (const int indent=0) const
	Returns collection of suboptions in the textual format.

void	unpackOptions (const OptionBuffer &buf)
	Builds a collection of sub options from the buffer.

Protected Attributes inherited from isc::dhcp::Option
OptionBuffer	data_
	contains content of this data

std::string	encapsulated_space_
	Name of the option space being encapsulated by this option.

OptionCollection	options_
	collection for storing suboptions

uint16_t	type_
	option type (0-255 for DHCPv4, 0-65535 for DHCPv6)

Universe	universe_
	option universe (V4 or V6)

Detailed Description

This class represents vendor-specific information option.

As specified in RFC3925, the option formatting is slightly different for DHCPv4 than DHCPv6. The DHCPv4 Option includes additional field holding vendor data length.

Definition at line 29 of file option_vendor.h.

Constructor & Destructor Documentation

◆ OptionVendor() [1/2]

OptionVendor::OptionVendor	(	Option::Universe	u,
		const uint32_t	vendor_id )

Constructor.

Parameters

u	universe (V4 or V6)
vendor_id	vendor enterprise-id (unique 32 bit integer)

Definition at line 18 of file option_vendor.cc.

◆ OptionVendor() [2/2]

OptionVendor::OptionVendor	(	Option::Universe	u,
		OptionBufferConstIter	begin,
		OptionBufferConstIter	end )

Constructor.

This constructor creates option from a buffer. This constructor may throw exception if unpack function throws during buffer parsing.

Parameters

u	universe (V4 or V6)
begin	iterator to first byte of option data.
end	iterator to end of option data (first byte after option end).

Exceptions

isc::OutOfRange if provided buffer is shorter than data size.

Todo: Extend constructor to set encapsulated option space name.

Definition at line 24 of file option_vendor.cc.

References unpack().

Here is the call graph for this function:

Member Function Documentation

◆ clone()

OptionPtr OptionVendor::clone ( ) const

virtual

Copies this option and returns a pointer to the copy.

Reimplemented from isc::dhcp::Option.

Definition at line 33 of file option_vendor.cc.

References isc::dhcp::Option::cloneInternal().

Here is the call graph for this function:

◆ getVendorId()

uint32_t isc::dhcp::OptionVendor::getVendorId ( ) const

inline

Returns enterprise identifier.

Returns: enterprise identifier

Definition at line 86 of file option_vendor.h.

◆ len()

uint16_t OptionVendor::len ( ) const

virtual

returns complete length of option

Returns length of this option, including option header and suboptions

Returns: length of this option

Reimplemented from isc::dhcp::Option.

Definition at line 80 of file option_vendor.cc.

References isc::dhcp::Option::getHeaderLen(), isc::dhcp::Option::options_, isc::dhcp::Option::universe_, and isc::dhcp::Option::V4.

Here is the call graph for this function:

◆ pack()

void OptionVendor::pack	(	isc::util::OutputBuffer &	buf,
		bool	check = true ) const

virtual

Writes option in wire-format to buf, returns pointer to first unused byte after stored option.

Parameters

[out]	buf	buffer (option will be stored here)
	check	if set to false, allows options larger than 255 for v4

Reimplemented from isc::dhcp::Option.

Definition at line 37 of file option_vendor.cc.

References isc::dhcp::Option::check(), isc::dhcp::Option::options_, isc::dhcp::Option::packHeader(), isc::dhcp::Option::packOptions(), isc::dhcp::Option::universe_, isc::dhcp::Option::V4, isc::util::OutputBuffer::writeUint32(), and isc::util::OutputBuffer::writeUint8().

Here is the call graph for this function:

◆ setVendorId()

void isc::dhcp::OptionVendor::setVendorId ( const uint32_t vendor_id )

inline

Sets enterprise identifier.

Parameters

vendor_id vendor identifier

Definition at line 79 of file option_vendor.h.

◆ toText()

std::string OptionVendor::toText ( int indent = 0 ) const

virtual

Returns the option in the textual format.

Parameters

indent Number of spaces to be inserted before the text.

Returns: Vendor option in the textual format.

Reimplemented from isc::dhcp::Option.

Definition at line 98 of file option_vendor.cc.

References isc::dhcp::Option::getUniverse(), isc::dhcp::Option::headerToText(), isc::dhcp::Option::options_, isc::dhcp::Option::suboptionsToText(), and isc::dhcp::Option::V4.

Here is the call graph for this function:

◆ unpack()

void OptionVendor::unpack	(	OptionBufferConstIter	begin,
		OptionBufferConstIter	end )

virtual

Parses received buffer.

Parses received buffer and returns offset to the first unused byte after parsed option.

Parameters

begin	iterator to first byte of option data
end	iterator to end of option data (first byte after option end)

Exceptions

isc::SkipRemainingOptionsBuffer if an error is encountered unpacking the option. This exception is thrown to indicate to the caller that a: remaining options cannot be parsed and b: the packet should be considered for processing anyway.

Reimplemented from isc::dhcp::Option.

Definition at line 59 of file option_vendor.cc.

References isc_throw, isc::dhcp::Option::options_, isc::util::readUint32(), isc::dhcp::Option::universe_, isc::dhcp::LibDHCP::unpackVendorOptions4(), isc::dhcp::LibDHCP::unpackVendorOptions6(), and isc::dhcp::Option::V6.

Referenced by OptionVendor().

Here is the call graph for this function:

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OptionVendor() [1/2]

◆ OptionVendor() [2/2]

Member Function Documentation

◆ clone()

◆ getVendorId()

◆ len()

◆ pack()

◆ setVendorId()

◆ toText()

◆ unpack()