Kea  2.1.7-git
isc::dhcp::OptionInt< T > Class Template Reference

Forward declaration to OptionInt. More...

#include <option_definition.h>

+ Inheritance diagram for isc::dhcp::OptionInt< T >:

Public Member Functions

 OptionInt (Option::Universe u, uint16_t type, T value)
 Constructor. More...
 
 OptionInt (Option::Universe u, uint16_t type, OptionBufferConstIter begin, OptionBufferConstIter end)
 Constructor. More...
 
virtual OptionPtr clone () const
 Copies this option and returns a pointer to the copy. More...
 
getValue () const
 Return option value. More...
 
virtual uint16_t len () const
 returns complete length of option More...
 
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. More...
 
void setValue (T value)
 Set option value. More...
 
virtual std::string toText (int indent=0) const
 Returns option carrying an integer value in the textual format. More...
 
virtual void unpack (OptionBufferConstIter begin, OptionBufferConstIter end)
 Parses received buffer. More...
 
- Public Member Functions inherited from isc::dhcp::Option
 Option (Universe u, uint16_t type)
 ctor, used for options constructed, usually during transmission More...
 
 Option (Universe u, uint16_t type, const OptionBuffer &data)
 Constructor, used for received options. More...
 
 Option (Universe u, uint16_t type, OptionBufferConstIter first, OptionBufferConstIter last)
 Constructor, used for received options. More...
 
 Option (const Option &source)
 Copy constructor. More...
 
virtual ~Option ()
 just to force that every option has virtual dtor More...
 
void addOption (OptionPtr opt)
 Adds a sub-option. More...
 
bool delOption (uint16_t type)
 Attempts to delete first suboption of requested type. More...
 
bool equals (const OptionPtr &other) const
 Checks if options are equal. More...
 
virtual bool equals (const Option &other) const
 Checks if two options are equal. More...
 
virtual const OptionBuffergetData () const
 Returns pointer to actual data. More...
 
std::string getEncapsulatedSpace () const
 Returns the name of the option space encapsulated by this option. More...
 
virtual uint16_t getHeaderLen () const
 Returns length of header (2 for v4, 4 for v6) More...
 
OptionCollectiongetMutableOptions ()
 Returns all encapsulated options. More...
 
OptionPtr getOption (uint16_t type) const
 Returns shared_ptr to suboption of specific type. More...
 
const OptionCollectiongetOptions () const
 Returns all encapsulated options. More...
 
void getOptionsCopy (OptionCollection &options_copy) const
 Performs deep copy of suboptions. More...
 
uint16_t getType () const
 Returns option type (0-255 for DHCPv4, 0-65535 for DHCPv6) More...
 
uint16_t getUint16 () const
 Returns content of first word. More...
 
uint32_t getUint32 () const
 Returns content of first double word. More...
 
uint8_t getUint8 () const
 Returns content of first byte. More...
 
Universe getUniverse () const
 returns option universe (V4 or V6) More...
 
Optionoperator= (const Option &rhs)
 Assignment operator. More...
 
template<typename InputIterator >
void setData (InputIterator first, InputIterator last)
 Sets content of this option from buffer. More...
 
void setEncapsulatedSpace (const std::string &encapsulated_space)
 Sets the name of the option space encapsulated by this option. More...
 
void setUint16 (uint16_t value)
 Sets content of this option to a single uint16 value. More...
 
void setUint32 (uint32_t value)
 Sets content of this option to a single uint32 value. More...
 
void setUint8 (uint8_t value)
 Sets content of this option to a single uint8 value. More...
 
virtual std::vector< uint8_t > toBinary (const bool include_header=false) const
 Returns binary representation of the option. More...
 
virtual std::string toHexString (const bool include_header=false) const
 Returns string containing hexadecimal representation of option. More...
 
virtual std::string toString () const
 Returns string representation of the value. More...
 
virtual bool valid () const
 returns if option is valid (e.g. More...
 

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 More...
 
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. More...
 
static OptionPtr create (Universe u, uint16_t type, const OptionBuffer &data)
 Factory function creating an instance of the Option. More...
 
static OptionPtr factory (Option::Universe u, uint16_t type, const OptionBuffer &buf)
 Factory function to create instance of option. More...
 
static OptionPtr factory (Option::Universe u, uint16_t type)
 Factory function to create instance of option. More...
 
- Static Public Attributes inherited from isc::dhcp::Option
static bool lenient_parsing_
 Governs whether options should be parsed less strictly. More...
 
static const size_t OPTION4_HDR_LEN = 2
 length of the usual DHCPv4 option header (there are exceptions) More...
 
static const size_t OPTION6_HDR_LEN = 4
 length of any DHCPv6 option header More...
 
- Protected Member Functions inherited from isc::dhcp::Option
void check () const
 A protected method used for option correctness. More...
 
template<typename OptionType >
OptionPtr cloneInternal () const
 Copies this option and returns a pointer to the copy. More...
 
std::string headerToText (const int indent=0, const std::string &type_name="") const
 Returns option header in the textual format. More...
 
void packHeader (isc::util::OutputBuffer &buf, bool check=true) const
 Store option's header in a buffer. More...
 
void packOptions (isc::util::OutputBuffer &buf, bool check=true) const
 Store sub options in a buffer. More...
 
std::string suboptionsToText (const int indent=0) const
 Returns collection of suboptions in the textual format. More...
 
void unpackOptions (const OptionBuffer &buf)
 Builds a collection of sub options from the buffer. More...
 
- Protected Attributes inherited from isc::dhcp::Option
OptionBuffer data_
 contains content of this data More...
 
std::string encapsulated_space_
 Name of the option space being encapsulated by this option. More...
 
OptionCollection options_
 collection for storing suboptions More...
 
uint16_t type_
 option type (0-255 for DHCPv4, 0-65535 for DHCPv6) More...
 
Universe universe_
 option universe (V4 or V6) More...
 

Detailed Description

template<typename T>
class isc::dhcp::OptionInt< T >

Forward declaration to OptionInt.

This template class represents DHCP option with single value.

This forward declaration is needed to access the OptionInt class without having to include the option_int.h header file. It is required because this header includes libdhcp++.h, and including option_int.h would cause circular inclusion between libdhcp++.h, option_definition.h and option6_int.h.

This value is of integer type and can be any of the following:

  • uint8_t,
  • uint16_t,
  • uint32_t,
  • int8_t,
  • int16_t,
  • int32_t.
Template Parameters
Tdata field type (see above).

Definition at line 65 of file option_definition.h.

Constructor & Destructor Documentation

◆ OptionInt() [1/2]

template<typename T >
isc::dhcp::OptionInt< T >::OptionInt ( Option::Universe  u,
uint16_t  type,
value 
)
inline

Constructor.

Parameters
uuniverse (V4 or V6)
typeoption type.
valueoption value.
Exceptions
isc::dhcp::InvalidDataTypeif data field type provided as template parameter is not a supported integer type.
Todo:
Extend constructor to set encapsulated option space name.

Definition at line 65 of file option_int.h.

References DHCP4_OPTION_SPACE, DHCP6_OPTION_SPACE, isc_throw, isc::dhcp::Option::setEncapsulatedSpace(), and isc::dhcp::Option::V4.

+ Here is the call graph for this function:

◆ OptionInt() [2/2]

template<typename T >
isc::dhcp::OptionInt< T >::OptionInt ( Option::Universe  u,
uint16_t  type,
OptionBufferConstIter  begin,
OptionBufferConstIter  end 
)
inline

Constructor.

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

Parameters
uuniverse (V4 or V6)
typeoption type.
beginiterator to first byte of option data.
enditerator to end of option data (first byte after option end).
Exceptions
isc::OutOfRangeif provided buffer is shorter than data size.
isc::dhcp::InvalidDataTypeif data field type provided as template parameter is not a supported integer type.
Todo:
Extend constructor to set encapsulated option space name.

Definition at line 88 of file option_int.h.

References DHCP4_OPTION_SPACE, DHCP6_OPTION_SPACE, isc_throw, isc::dhcp::Option::setEncapsulatedSpace(), isc::dhcp::OptionInt< T >::unpack(), and isc::dhcp::Option::V4.

+ Here is the call graph for this function:

Member Function Documentation

◆ clone()

template<typename T >
virtual OptionPtr isc::dhcp::OptionInt< T >::clone ( ) const
inlinevirtual

Copies this option and returns a pointer to the copy.

Reimplemented from isc::dhcp::Option.

Definition at line 99 of file option_int.h.

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

+ Here is the call graph for this function:

◆ getValue()

template<typename T >
T isc::dhcp::OptionInt< T >::getValue ( ) const
inline

Return option value.

Returns
option value.

Definition at line 190 of file option_int.h.

Referenced by isc::dhcp::AllocEngine::getValidLft(), and isc::dhcp::OptionInt< T >::toText().

◆ len()

template<typename T >
virtual uint16_t isc::dhcp::OptionInt< T >::len ( ) const
inlinevirtual

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 197 of file option_int.h.

References isc::dhcp::Option::getUniverse(), isc::dhcp::Option::OPTION4_HDR_LEN, isc::dhcp::Option::OPTION6_HDR_LEN, isc::dhcp::Option::options_, and isc::dhcp::Option::V4.

+ Here is the call graph for this function:

◆ pack()

template<typename T >
virtual void isc::dhcp::OptionInt< T >::pack ( isc::util::OutputBuffer buf,
bool  check = true 
) const
inlinevirtual

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

Parameters
[out]bufbuffer (option will be stored here)
Exceptions
isc::dhcp::InvalidDataTypeif size of a data field type is not equal to 1, 2 or 4 bytes. The data type is not checked in this function because it is checked in a constructor.

Reimplemented from isc::dhcp::Option.

Definition at line 111 of file option_int.h.

References isc::dhcp::Option::check(), isc_throw, isc::dhcp::Option::packHeader(), isc::dhcp::Option::packOptions(), isc::util::OutputBuffer::writeUint16(), isc::util::OutputBuffer::writeUint32(), and isc::util::OutputBuffer::writeUint8().

+ Here is the call graph for this function:

◆ setValue()

template<typename T >
void isc::dhcp::OptionInt< T >::setValue ( value)
inline

Set option value.

Parameters
valuenew option value.

Definition at line 185 of file option_int.h.

Referenced by isc::dhcp::Pkt4::setType().

◆ toText()

template<typename T >
virtual std::string isc::dhcp::OptionInt< T >::toText ( int  indent = 0) const
inlinevirtual

Returns option carrying an integer value in the textual format.

The returned value also includes the suboptions if present.

Parameters
indentNumber of spaces to be inserted before the text.

Reimplemented from isc::dhcp::Option.

Definition at line 217 of file option_int.h.

References isc::dhcp::OptionDataTypeUtil::getDataTypeName(), isc::dhcp::OptionInt< T >::getValue(), isc::dhcp::Option::headerToText(), and isc::dhcp::Option::suboptionsToText().

+ Here is the call graph for this function:

◆ unpack()

template<typename T >
virtual void isc::dhcp::OptionInt< T >::unpack ( OptionBufferConstIter  begin,
OptionBufferConstIter  end 
)
inlinevirtual

Parses received buffer.

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

Parameters
beginiterator to first byte of option data
enditerator to end of option data (first byte after option end)
Exceptions
isc::OutOfRangeif provided buffer is shorter than data size.
isc::dhcp::InvalidDataTypeif size of a data field type is not equal to 1, 2 or 4 bytes. The data type is not checked in this function because it is checked in a constructor.

Reimplemented from isc::dhcp::Option.

Definition at line 147 of file option_int.h.

References isc::dhcp::Option::getType(), isc_throw, isc::util::readUint16(), isc::util::readUint32(), and isc::dhcp::Option::unpackOptions().

Referenced by isc::dhcp::OptionInt< T >::OptionInt().

+ Here is the call graph for this function:

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