Kea  2.1.7-git
isc::dhcp::Option6IA Class Reference

#include <option6_ia.h>

+ Inheritance diagram for isc::dhcp::Option6IA:

Public Member Functions

 Option6IA (uint16_t type, uint32_t iaid)
 Ctor, used for constructed options, usually during transmission. More...
 
 Option6IA (uint16_t type, OptionBuffer::const_iterator begin, OptionBuffer::const_iterator end)
 Ctor, used for received options. More...
 
virtual OptionPtr clone () const
 Copies this option and returns a pointer to the copy. More...
 
uint32_t getIAID () const
 Returns IA identifier. More...
 
uint32_t getT1 () const
 Returns T1 timer. More...
 
uint32_t getT2 () const
 Returns T2 timer. More...
 
virtual uint16_t len () const
 returns complete length of option More...
 
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 setIAID (uint32_t iaid)
 Sets Identity Association Identifier. More...
 
void setT1 (uint32_t t1)
 Sets T1 timer. More...
 
void setT2 (uint32_t t2)
 Sets T2 timer. More...
 
virtual std::string toText (int indent=0) const
 Provides human readable text representation. 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...
 

Static Public Attributes

static const size_t OPTION6_IA_LEN = 12
 Length of IA_NA and IA_PD content. 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

uint32_t iaid_
 keeps IA identifier More...
 
uint32_t t1_
 keeps T1 timer value More...
 
uint32_t t2_
 keeps T2 timer value 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, 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...
 

Detailed Description

Definition at line 22 of file option6_ia.h.

Constructor & Destructor Documentation

◆ Option6IA() [1/2]

isc::dhcp::Option6IA::Option6IA ( uint16_t  type,
uint32_t  iaid 
)

Ctor, used for constructed options, usually during transmission.

Parameters
typeoption type (usually 4 for IA_NA, 25 for IA_PD)
iaididentity association identifier (id of IA)

Definition at line 25 of file option6_ia.cc.

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

+ Here is the call graph for this function:

◆ Option6IA() [2/2]

isc::dhcp::Option6IA::Option6IA ( uint16_t  type,
OptionBuffer::const_iterator  begin,
OptionBuffer::const_iterator  end 
)

Ctor, used for received options.

Parameters
typeoption type (usually 4 for IA_NA, 25 for IA_PD)
beginiterator to first byte of option data
enditerator to end of option data (first byte after option end)

Definition at line 37 of file option6_ia.cc.

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

+ Here is the call graph for this function:

Member Function Documentation

◆ clone()

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

Copies this option and returns a pointer to the copy.

Reimplemented from isc::dhcp::Option.

Definition at line 53 of file option6_ia.cc.

◆ getIAID()

uint32_t isc::dhcp::Option6IA::getIAID ( ) const
inline

Returns IA identifier.

Returns
IAID value.

Definition at line 86 of file option6_ia.h.

References iaid_.

◆ getT1()

uint32_t isc::dhcp::Option6IA::getT1 ( ) const
inline

Returns T1 timer.

Returns
T1 value.

Definition at line 91 of file option6_ia.h.

References t1_.

◆ getT2()

uint32_t isc::dhcp::Option6IA::getT2 ( ) const
inline

Returns T2 timer.

Returns
T2 value.

Definition at line 96 of file option6_ia.h.

References len(), and t2_.

+ Here is the call graph for this function:

◆ len()

uint16_t isc::dhcp::Option6IA::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 105 of file option6_ia.cc.

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

Referenced by getT2(), and pack().

◆ pack()

void isc::dhcp::Option6IA::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
bufbuffer (option will be stored here)

Reimplemented from isc::dhcp::Option.

Definition at line 57 of file option6_ia.cc.

References iaid_, len(), isc::dhcp::Option::OPTION6_HDR_LEN, isc::dhcp::Option::packOptions(), t1_, t2_, isc::dhcp::Option::type_, isc::util::OutputBuffer::writeUint16(), and isc::util::OutputBuffer::writeUint32().

+ Here is the call graph for this function:

◆ setIAID()

void isc::dhcp::Option6IA::setIAID ( uint32_t  iaid)
inline

Sets Identity Association Identifier.

Parameters
iaidIAID value to be set

Definition at line 80 of file option6_ia.h.

References iaid_.

◆ setT1()

void isc::dhcp::Option6IA::setT1 ( uint32_t  t1)
inline

Sets T1 timer.

Parameters
t1t1 value to be set

Definition at line 70 of file option6_ia.h.

References t1_.

◆ setT2()

void isc::dhcp::Option6IA::setT2 ( uint32_t  t2)
inline

Sets T2 timer.

Parameters
t2t2 value to be set

Definition at line 75 of file option6_ia.h.

References t2_.

◆ toText()

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

Provides human readable text representation.

Parameters
indentnumber of leading space characters
Returns
string with text representation

Reimplemented from isc::dhcp::Option.

Definition at line 85 of file option6_ia.cc.

References D6O_IA_NA, D6O_IA_PD, isc::dhcp::Option::getType(), isc::dhcp::Option::headerToText(), iaid_, isc::dhcp::Option::suboptionsToText(), t1_, and t2_.

+ Here is the call graph for this function:

◆ unpack()

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

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)

Reimplemented from isc::dhcp::Option.

Definition at line 67 of file option6_ia.cc.

References iaid_, isc_throw, OPTION6_IA_LEN, isc::util::readUint32(), t1_, t2_, isc::dhcp::Option::type_, and isc::dhcp::Option::unpackOptions().

Referenced by Option6IA().

+ Here is the call graph for this function:

Member Data Documentation

◆ iaid_

uint32_t isc::dhcp::Option6IA::iaid_
protected

keeps IA identifier

Definition at line 108 of file option6_ia.h.

Referenced by getIAID(), pack(), setIAID(), toText(), and unpack().

◆ OPTION6_IA_LEN

const size_t isc::dhcp::Option6IA::OPTION6_IA_LEN = 12
static

Length of IA_NA and IA_PD content.

Definition at line 26 of file option6_ia.h.

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

◆ t1_

uint32_t isc::dhcp::Option6IA::t1_
protected

keeps T1 timer value

Definition at line 111 of file option6_ia.h.

Referenced by getT1(), pack(), setT1(), toText(), and unpack().

◆ t2_

uint32_t isc::dhcp::Option6IA::t2_
protected

keeps T2 timer value

Definition at line 114 of file option6_ia.h.

Referenced by getT2(), pack(), setT2(), toText(), and unpack().


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