Kea  2.1.2-git
isc::dhcp::Option6IAAddr Class Reference

#include <option6_iaaddr.h>

+ Inheritance diagram for isc::dhcp::Option6IAAddr:

Public Member Functions

 Option6IAAddr (uint16_t type, const isc::asiolink::IOAddress &addr, uint32_t preferred, uint32_t valid)
 Constructor, used for options constructed (during transmission). More...
 
 Option6IAAddr (uint32_t type, OptionBuffer::const_iterator begin, OptionBuffer::const_iterator end)
 Constructor, used for received options. More...
 
virtual OptionPtr clone () const
 Copies this option and returns a pointer to the copy. More...
 
isc::asiolink::IOAddress getAddress () const
 Returns address contained within this option. More...
 
unsigned int getPreferred () const
 Returns preferred lifetime of an address. More...
 
unsigned int getValid () const
 Returns valid lifetime of an address. More...
 
virtual uint16_t len () const
 returns data length (data length + DHCPv4/DHCPv6 option header) More...
 
void pack (isc::util::OutputBuffer &buf) const
 Writes option in wire-format. More...
 
void setAddress (const isc::asiolink::IOAddress &addr)
 sets address in this option. More...
 
void setPreferred (unsigned int pref)
 Sets preferred lifetime (in seconds) More...
 
void setValid (unsigned int valid)
 Sets valid lifetime (in seconds). More...
 
virtual std::string toText (int indent=0) const
 Returns string representation of the option. 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...
 
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...
 

Static Public Attributes

static const size_t OPTION6_IAADDR_LEN = 24
 length of the fixed part of the IAADDR 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 Attributes

isc::asiolink::IOAddress addr_
 contains an IPv6 address More...
 
unsigned int preferred_
 contains preferred-lifetime timer (in seconds) More...
 
unsigned int valid_
 contains valid-lifetime timer (in seconds) 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...
 

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...
 
- 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) const
 Store option's header in a buffer. More...
 
void packOptions (isc::util::OutputBuffer &buf) 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...
 

Detailed Description

Definition at line 22 of file option6_iaaddr.h.

Constructor & Destructor Documentation

◆ Option6IAAddr() [1/2]

isc::dhcp::Option6IAAddr::Option6IAAddr ( uint16_t  type,
const isc::asiolink::IOAddress addr,
uint32_t  preferred,
uint32_t  valid 
)

Constructor, used for options constructed (during transmission).

Exceptions
BadValueif specified addr is not IPv6
Parameters
typeoption type
addrreference to an address
preferredaddress preferred lifetime (in seconds)
validaddress valid lifetime (in seconds)

Definition at line 29 of file option6_iaaddr.cc.

References addr_, DHCP6_OPTION_SPACE, isc_throw, isc::asiolink::IOAddress::isV6(), and isc::dhcp::Option::setEncapsulatedSpace().

+ Here is the call graph for this function:

◆ Option6IAAddr() [2/2]

isc::dhcp::Option6IAAddr::Option6IAAddr ( uint32_t  type,
OptionBuffer::const_iterator  begin,
OptionBuffer::const_iterator  end 
)

Constructor, used for received options.

Exceptions
OutOfRangeif specified option is truncated
Parameters
typeoption type
beginiterator to first byte of option data
enditerator to end of option data (first byte after option end)

Definition at line 39 of file option6_iaaddr.cc.

References DHCP6_OPTION_SPACE, isc::dhcp::Option::setEncapsulatedSpace(), and unpack().

+ Here is the call graph for this function:

Member Function Documentation

◆ clone()

OptionPtr isc::dhcp::Option6IAAddr::clone ( ) const
virtual

Copies this option and returns a pointer to the copy.

Reimplemented from isc::dhcp::Option.

Reimplemented in isc::dhcp::Option6IAPrefix.

Definition at line 47 of file option6_iaaddr.cc.

◆ getAddress()

isc::asiolink::IOAddress isc::dhcp::Option6IAAddr::getAddress ( ) const
inline

Returns address contained within this option.

Returns
address

Definition at line 97 of file option6_iaaddr.h.

References addr_.

Referenced by isc::dhcp::Dhcpv6Srv::processConfirm().

◆ getPreferred()

unsigned int isc::dhcp::Option6IAAddr::getPreferred ( ) const
inline

Returns preferred lifetime of an address.

Returns
preferred lifetime (in seconds)

Definition at line 103 of file option6_iaaddr.h.

References preferred_.

◆ getValid()

unsigned int isc::dhcp::Option6IAAddr::getValid ( ) const
inline

Returns valid lifetime of an address.

Returns
valid lifetime (in seconds)

Definition at line 109 of file option6_iaaddr.h.

References len(), and valid_.

+ Here is the call graph for this function:

◆ len()

uint16_t isc::dhcp::Option6IAAddr::len ( ) const
virtual

returns data length (data length + DHCPv4/DHCPv6 option header)

Reimplemented from isc::dhcp::Option.

Reimplemented in isc::dhcp::Option6IAPrefix.

Definition at line 101 of file option6_iaaddr.cc.

References isc::dhcp::Option::OPTION6_HDR_LEN, OPTION6_IAADDR_LEN, and isc::dhcp::Option::options_.

Referenced by getValid(), and pack().

◆ pack()

void isc::dhcp::Option6IAAddr::pack ( isc::util::OutputBuffer buf) const
virtual

Writes option in wire-format.

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

Parameters
bufpointer to a buffer

Reimplemented from isc::dhcp::Option.

Reimplemented in isc::dhcp::Option6IAPrefix.

Definition at line 51 of file option6_iaaddr.cc.

References addr_, isc::dhcp::Option::getHeaderLen(), isc_throw, isc::asiolink::IOAddress::isV6(), len(), isc::dhcp::Option::packOptions(), preferred_, isc::asiolink::IOAddress::toBytes(), isc::dhcp::Option::type_, valid_, isc::util::OutputBuffer::writeData(), isc::util::OutputBuffer::writeUint16(), and isc::util::OutputBuffer::writeUint32().

+ Here is the call graph for this function:

◆ setAddress()

void isc::dhcp::Option6IAAddr::setAddress ( const isc::asiolink::IOAddress addr)
inline

sets address in this option.

Parameters
addraddress to be sent in this option

Definition at line 79 of file option6_iaaddr.h.

References addr_.

◆ setPreferred()

void isc::dhcp::Option6IAAddr::setPreferred ( unsigned int  pref)
inline

Sets preferred lifetime (in seconds)

Parameters
prefaddress preferred lifetime (in seconds)

Definition at line 85 of file option6_iaaddr.h.

References preferred_.

◆ setValid()

void isc::dhcp::Option6IAAddr::setValid ( unsigned int  valid)
inline

Sets valid lifetime (in seconds).

Parameters
validaddress valid lifetime (in seconds)

Definition at line 91 of file option6_iaaddr.h.

References isc::dhcp::Option::valid(), and valid_.

+ Here is the call graph for this function:

◆ toText()

std::string isc::dhcp::Option6IAAddr::toText ( int  indent = 0) const
virtual

Returns string representation of the option.

Parameters
indentnumber of spaces before printing text
Returns
string with text representation.

Reimplemented from isc::dhcp::Option.

Reimplemented in isc::dhcp::Option6IAPrefix.

Definition at line 90 of file option6_iaaddr.cc.

References addr_, isc::dhcp::Option::headerToText(), preferred_, isc::dhcp::Option::suboptionsToText(), and valid_.

Referenced by isc::perfdhcp::TestControl::address6Uniqueness().

+ Here is the call graph for this function:

◆ unpack()

void isc::dhcp::Option6IAAddr::unpack ( OptionBufferConstIter  begin,
OptionBufferConstIter  end 
)
virtual

Parses received buffer.

Parameters
beginiterator to first byte of option data
enditerator to end of option data (first byte after option end)

Reimplemented from isc::dhcp::Option.

Reimplemented in isc::dhcp::Option6IAPrefix.

Definition at line 71 of file option6_iaaddr.cc.

References addr_, isc::asiolink::IOAddress::fromBytes(), isc_throw, OPTION6_IAADDR_LEN, and isc::dhcp::Option::type_.

Referenced by Option6IAAddr().

+ Here is the call graph for this function:

Member Data Documentation

◆ addr_

◆ OPTION6_IAADDR_LEN

const size_t isc::dhcp::Option6IAAddr::OPTION6_IAADDR_LEN = 24
static

length of the fixed part of the IAADDR option

Definition at line 26 of file option6_iaaddr.h.

Referenced by isc::dhcp::OptionDefinition::factoryIAAddr6(), len(), and unpack().

◆ preferred_

unsigned int isc::dhcp::Option6IAAddr::preferred_
protected

◆ valid_

unsigned int isc::dhcp::Option6IAAddr::valid_
protected

contains valid-lifetime timer (in seconds)

Definition at line 122 of file option6_iaaddr.h.

Referenced by getValid(), pack(), isc::dhcp::Option6IAPrefix::pack(), setValid(), toText(), isc::dhcp::Option6IAPrefix::toText(), and isc::dhcp::Option6IAPrefix::unpack().


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