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

DHCPv6 option class representing Prefix Exclude Option (RFC 6603). More...

#include <option6_pdexclude.h>

+ Inheritance diagram for isc::dhcp::Option6PDExclude:

Public Member Functions

 Option6PDExclude (const isc::asiolink::IOAddress &delegated_prefix, const uint8_t delegated_prefix_length, const isc::asiolink::IOAddress &excluded_prefix, const uint8_t excluded_prefix_length)
 Constructor. More...
 
 Option6PDExclude (OptionBufferConstIter begin, OptionBufferConstIter end)
 Constructor, creates option instance from part of the buffer. More...
 
virtual OptionPtr clone () const
 Copies this option and returns a pointer to the copy. More...
 
asiolink::IOAddress getExcludedPrefix (const asiolink::IOAddress &delegated_prefix, const uint8_t delegated_prefix_length) const
 Returns excluded prefix. More...
 
uint8_t getExcludedPrefixLength () const
 Returns excluded prefix length. More...
 
const std::vector< uint8_t > & getExcludedPrefixSubnetID () const
 Returns an excluded prefix in a binary format. More...
 
virtual uint16_t len () const
 Returns length of the complete option (data length + DHCPv6 option header) More...
 
virtual void pack (isc::util::OutputBuffer &buf, bool check=true) const
 Writes option in wire-format to a buffer. More...
 
virtual std::string toText (int indent=0) const
 Returns Prefix Exclude option in 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

DHCPv6 option class representing Prefix Exclude Option (RFC 6603).

This class represents DHCPv6 Prefix Exclude option (67). This option is carried in the IA Prefix option and it conveys a single prefix which is used by the delegating router to communicate with a requesting router on the requesting router's uplink. This prefix is not used on the requesting router's downlinks (is excluded from other delegated prefixes).

Definition at line 25 of file option6_pdexclude.h.

Constructor & Destructor Documentation

◆ Option6PDExclude() [1/2]

isc::dhcp::Option6PDExclude::Option6PDExclude ( const isc::asiolink::IOAddress delegated_prefix,
const uint8_t  delegated_prefix_length,
const isc::asiolink::IOAddress excluded_prefix,
const uint8_t  excluded_prefix_length 
)

Constructor.

Parameters
delegated_prefixDelegated prefix.
delegated_prefix_lengthDelegated prefix length.
excluded_prefixExcluded prefix.
excluded_prefix_lengthExcluded prefix length.
Exceptions
BadValueif prefixes are invalid, if excluded prefix length is not greater than delegated prefix length or if common parts of prefixes does not match.

Definition at line 29 of file option6_pdexclude.cc.

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

+ Here is the call graph for this function:

◆ Option6PDExclude() [2/2]

isc::dhcp::Option6PDExclude::Option6PDExclude ( OptionBufferConstIter  begin,
OptionBufferConstIter  end 
)

Constructor, creates option instance from part of the buffer.

This constructor is mostly used to parse Prefix Exclude options in the received messages.

Parameters
beginLower bound of the buffer to create option from.
endUpper bound of the buffer to create option from.

Definition at line 115 of file option6_pdexclude.cc.

References unpack().

+ Here is the call graph for this function:

Member Function Documentation

◆ clone()

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

Copies this option and returns a pointer to the copy.

Reimplemented from isc::dhcp::Option.

Definition at line 124 of file option6_pdexclude.cc.

◆ getExcludedPrefix()

asiolink::IOAddress isc::dhcp::Option6PDExclude::getExcludedPrefix ( const asiolink::IOAddress delegated_prefix,
const uint8_t  delegated_prefix_length 
) const

Returns excluded prefix.

Assembles excluded prefix from a delegated prefix and IPv6 subnet id specified as in RFC6603, section 4.2.

Parameters
delegated_prefixDelegated prefix for which excluded prefix will be returned.
delegated_prefix_lengthDelegated prefix length.

Definition at line 194 of file option6_pdexclude.cc.

References isc::asiolink::IOAddress::toBytes().

+ Here is the call graph for this function:

◆ getExcludedPrefixLength()

uint8_t isc::dhcp::Option6PDExclude::getExcludedPrefixLength ( ) const
inline

Returns excluded prefix length.

Definition at line 99 of file option6_pdexclude.h.

◆ getExcludedPrefixSubnetID()

const std::vector<uint8_t>& isc::dhcp::Option6PDExclude::getExcludedPrefixSubnetID ( ) const
inline

Returns an excluded prefix in a binary format.

Definition at line 104 of file option6_pdexclude.h.

◆ len()

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

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

Returns
length of the option

Reimplemented from isc::dhcp::Option.

Definition at line 180 of file option6_pdexclude.cc.

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

+ Here is the call graph for this function:

◆ pack()

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

Writes option in wire-format to a buffer.

Writes option in wire-format to buffer, returns pointer to first unused byte after stored option (that is useful for writing options one after another).

The format of the option includes excluded prefix length specified as a number of bits. It also includes IPv6 subnet ID field which is computed from the delegated and excluded prefixes, according to the section 4.2 of RFC 6603.

Parameters
[out]bufPointer to a buffer.

Reimplemented from isc::dhcp::Option.

Definition at line 129 of file option6_pdexclude.cc.

References isc_throw, isc::dhcp::Option::packHeader(), isc::util::OutputBuffer::writeData(), and isc::util::OutputBuffer::writeUint8().

+ Here is the call graph for this function:

◆ toText()

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

Returns Prefix Exclude option in textual format.

Parameters
indentNumber of spaces to be inserted before the text.

Reimplemented from isc::dhcp::Option.

Definition at line 185 of file option6_pdexclude.cc.

References isc::util::encode::encodeHex(), and isc::dhcp::Option::headerToText().

+ Here is the call graph for this function:

◆ unpack()

void isc::dhcp::Option6PDExclude::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.

Definition at line 148 of file option6_pdexclude.cc.

References isc_throw.

Referenced by Option6PDExclude().


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