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

DHCPv6 Option class for handling list of IPv6 addresses. More...

#include <option6_addrlst.h>

+ Inheritance diagram for isc::dhcp::Option6AddrLst:

Public Types

typedef std::vector< isc::asiolink::IOAddressAddressContainer
 a container for (IPv6) addresses More...
 
- 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...
 

Public Member Functions

 Option6AddrLst (uint16_t type, const AddressContainer &addrs)
 Constructor used during option generation. More...
 
 Option6AddrLst (uint16_t type, const isc::asiolink::IOAddress &addr)
 Simplified constructor for a single address. More...
 
 Option6AddrLst (uint16_t type, OptionBufferConstIter begin, OptionBufferConstIter end)
 Constructor used for parsing received option. More...
 
virtual OptionPtr clone () const
 Copies this option and returns a pointer to the copy. More...
 
AddressContainer getAddresses () const
 Returns vector with addresses. More...
 
virtual uint16_t len () const
 Returns length of the complete option (data length + DHCPv4/DHCPv6 option header) More...
 
void pack (isc::util::OutputBuffer &buf, bool check=true) const
 Assembles on-wire form of this option. More...
 
void setAddress (const isc::asiolink::IOAddress &addr)
 Sets a single address. More...
 
void setAddresses (const AddressContainer &addrs)
 Sets list of addresses. 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 data. 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...
 

Protected Attributes

AddressContainer addrs_
 
- 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

- 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...
 

Detailed Description

DHCPv6 Option class for handling list of IPv6 addresses.

This class handles a list of IPv6 addresses. An example of such option is dns-servers option. It can also be used to handle single address.

Definition at line 22 of file option6_addrlst.h.

Member Typedef Documentation

◆ AddressContainer

a container for (IPv6) addresses

Definition at line 26 of file option6_addrlst.h.

Constructor & Destructor Documentation

◆ Option6AddrLst() [1/3]

isc::dhcp::Option6AddrLst::Option6AddrLst ( uint16_t  type,
const AddressContainer addrs 
)

Constructor used during option generation.

Parameters
typeoption type
addrsvector of addresses to be stored

Definition at line 30 of file option6_addrlst.cc.

◆ Option6AddrLst() [2/3]

isc::dhcp::Option6AddrLst::Option6AddrLst ( uint16_t  type,
const isc::asiolink::IOAddress addr 
)

Simplified constructor for a single address.

Parameters
typeoption type
addra single address to be stored

Definition at line 34 of file option6_addrlst.cc.

◆ Option6AddrLst() [3/3]

isc::dhcp::Option6AddrLst::Option6AddrLst ( uint16_t  type,
OptionBufferConstIter  begin,
OptionBufferConstIter  end 
)

Constructor used for parsing received option.

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

Definition at line 38 of file option6_addrlst.cc.

References unpack().

+ Here is the call graph for this function:

Member Function Documentation

◆ clone()

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

Copies this option and returns a pointer to the copy.

This function must be overridden in the derived classes to make a copy of the derived type. The simplest way to do it is by calling cloneInternal function with an appropriate template parameter.

Returns
Pointer to the copy of the option.

Reimplemented from isc::dhcp::Option.

Definition at line 45 of file option6_addrlst.cc.

◆ getAddresses()

AddressContainer isc::dhcp::Option6AddrLst::getAddresses ( ) const
inline

Returns vector with addresses.

We return a copy of our list. Although this includes overhead, it also makes this list safe to use after this option object is no longer available. As options are expected to hold only a few (1-3) addresses, the overhead is not that big.

Returns
address container with addresses

Definition at line 82 of file option6_addrlst.h.

References addrs_, and len().

+ Here is the call graph for this function:

◆ len()

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

Returns length of the complete option (data length + DHCPv4/DHCPv6 option header)

Returns
length of the option

Reimplemented from isc::dhcp::Option.

Definition at line 107 of file option6_addrlst.cc.

References addrs_, and isc::dhcp::Option::OPTION6_HDR_LEN.

Referenced by getAddresses(), and pack().

◆ pack()

void isc::dhcp::Option6AddrLst::pack ( isc::util::OutputBuffer buf,
bool  check = true 
) const
virtual

Assembles on-wire form of this option.

Parameters
bufpointer to packet buffer

Reimplemented from isc::dhcp::Option.

Definition at line 64 of file option6_addrlst.cc.

References addrs_, isc::dhcp::Option::getHeaderLen(), isc_throw, len(), isc::dhcp::Option::type_, isc::util::OutputBuffer::writeData(), and isc::util::OutputBuffer::writeUint16().

+ Here is the call graph for this function:

◆ setAddress()

void isc::dhcp::Option6AddrLst::setAddress ( const isc::asiolink::IOAddress addr)

Sets a single address.

Parameters
addra single address to be added

Definition at line 50 of file option6_addrlst.cc.

References addrs_, isc_throw, and isc::asiolink::IOAddress::isV6().

+ Here is the call graph for this function:

◆ setAddresses()

void isc::dhcp::Option6AddrLst::setAddresses ( const AddressContainer addrs)

Sets list of addresses.

Parameters
addrsa vector of addresses to be added

Definition at line 60 of file option6_addrlst.cc.

References addrs_.

◆ toText()

std::string isc::dhcp::Option6AddrLst::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.

Definition at line 96 of file option6_addrlst.cc.

References addrs_, and isc::dhcp::Option::headerToText().

+ Here is the call graph for this function:

◆ unpack()

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

Parses received data.

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 83 of file option6_addrlst.cc.

Referenced by Option6AddrLst().

Member Data Documentation

◆ addrs_

AddressContainer isc::dhcp::Option6AddrLst::addrs_
protected

Definition at line 88 of file option6_addrlst.h.

Referenced by getAddresses(), len(), pack(), setAddress(), setAddresses(), and toText().


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