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

Implements the logic for the Option6ClientFqdn class. More...

Public Member Functions

 Option6ClientFqdnImpl (const uint8_t flags, const std::string &domain_name, const Option6ClientFqdn::DomainNameType name_type)
 Constructor, from domain name. More...
 
 Option6ClientFqdnImpl (OptionBufferConstIter first, OptionBufferConstIter last)
 Constructor, from wire data. More...
 
 Option6ClientFqdnImpl (const Option6ClientFqdnImpl &source)
 Copy constructor. More...
 
Option6ClientFqdnImploperator= (const Option6ClientFqdnImpl &source)
 Assignment operator. More...
 
void parseWireData (OptionBufferConstIter first, OptionBufferConstIter last)
 Parse the Option provided in the wire format. More...
 
void setDomainName (const std::string &domain_name, const Option6ClientFqdn::DomainNameType name_type)
 Set a new domain name for the option. More...
 

Static Public Member Functions

static void checkFlags (const uint8_t flags, const bool check_mbz)
 Check if flags are valid. More...
 

Public Attributes

boost::shared_ptr< isc::dns::Namedomain_name_
 Holds the pointer to a domain name carried in the option. More...
 
Option6ClientFqdn::DomainNameType domain_name_type_
 Indicates whether domain name is partial or fully qualified. More...
 
uint8_t flags_
 Holds flags carried by the option. More...
 

Detailed Description

Implements the logic for the Option6ClientFqdn class.

The purpose of the class is to separate the implementation details of the Option6ClientFqdn class from the interface. This implementation uses kea-libdns classes to process FQDNs. At some point it may be desired to split kea-libdhcp++ from kea-libdns. In such case the implementation of this class may be changed. The declaration of the Option6ClientFqdn class holds the pointer to implementation, so the transition to a different implementation would not affect the header file.

Definition at line 30 of file option6_client_fqdn.cc.

Constructor & Destructor Documentation

◆ Option6ClientFqdnImpl() [1/3]

isc::dhcp::Option6ClientFqdnImpl::Option6ClientFqdnImpl ( const uint8_t  flags,
const std::string &  domain_name,
const Option6ClientFqdn::DomainNameType  name_type 
)

Constructor, from domain name.

Parameters
flagsA value of the flags option field.
domain_nameA domain name carried by the option given in the textual format.
name_typeA value which indicates whether domain-name is partial or fully qualified.

Definition at line 102 of file option6_client_fqdn.cc.

References checkFlags(), flags_, and setDomainName().

Referenced by Option6ClientFqdnImpl().

+ Here is the call graph for this function:

◆ Option6ClientFqdnImpl() [2/3]

isc::dhcp::Option6ClientFqdnImpl::Option6ClientFqdnImpl ( OptionBufferConstIter  first,
OptionBufferConstIter  last 
)

Constructor, from wire data.

Parameters
firstAn iterator pointing to the beginning of the option data in the wire format.
lastAn iterator pointing to the end of the option data in the wire format.

Definition at line 121 of file option6_client_fqdn.cc.

References checkFlags(), flags_, Option6ClientFqdnImpl(), and parseWireData().

+ Here is the call graph for this function:

◆ Option6ClientFqdnImpl() [3/3]

isc::dhcp::Option6ClientFqdnImpl::Option6ClientFqdnImpl ( const Option6ClientFqdnImpl source)

Copy constructor.

Parameters
sourceAn object being copied.

Definition at line 130 of file option6_client_fqdn.cc.

References domain_name_.

Member Function Documentation

◆ checkFlags()

void isc::dhcp::Option6ClientFqdnImpl::checkFlags ( const uint8_t  flags,
const bool  check_mbz 
)
static

Check if flags are valid.

In particular, this function checks if the N and S bits are not set to 1 in the same time.

Parameters
flagsA value carried by the flags field of the option.
check_mbzA boolean value which indicates if this function should check if the MBZ bits are set (if true). This parameter should be set to false when validating flags in the received message. This is because server should ignore MBZ bits in received messages.
Exceptions
InvalidOption6FqdnFlagsif flags are invalid.

Definition at line 198 of file option6_client_fqdn.cc.

References isc::dhcp::Option6ClientFqdn::FLAG_MASK, isc::dhcp::Option6ClientFqdn::FLAG_N, isc::dhcp::Option6ClientFqdn::FLAG_S, and isc_throw.

Referenced by Option6ClientFqdnImpl(), isc::dhcp::Option6ClientFqdn::setFlag(), and isc::dhcp::Option6ClientFqdn::unpack().

◆ operator=()

Option6ClientFqdnImpl & isc::dhcp::Option6ClientFqdnImpl::operator= ( const Option6ClientFqdnImpl source)

Assignment operator.

Parameters
sourceAn object which is being assigned.

Definition at line 143 of file option6_client_fqdn.cc.

References domain_name_, domain_name_type_, flags_, and setDomainName().

+ Here is the call graph for this function:

◆ parseWireData()

void isc::dhcp::Option6ClientFqdnImpl::parseWireData ( OptionBufferConstIter  first,
OptionBufferConstIter  last 
)

Parse the Option provided in the wire format.

Parameters
firstAn iterator pointing to the beginning of the option data in the wire format.
lastAn iterator pointing to the end of the option data in the wire format.

Definition at line 218 of file option6_client_fqdn.cc.

References D6O_CLIENT_FQDN, domain_name_, domain_name_type_, isc::dhcp::Option6ClientFqdn::FLAG_FIELD_LEN, flags_, isc::dhcp::Option6ClientFqdn::FULL, isc_throw, and isc::dhcp::Option6ClientFqdn::PARTIAL.

Referenced by Option6ClientFqdnImpl(), and isc::dhcp::Option6ClientFqdn::unpack().

◆ setDomainName()

void isc::dhcp::Option6ClientFqdnImpl::setDomainName ( const std::string &  domain_name,
const Option6ClientFqdn::DomainNameType  name_type 
)

Set a new domain name for the option.

Parameters
domain_nameA new domain name to be assigned.
name_typeA value which indicates whether the domain-name is partial or fully qualified.

Definition at line 161 of file option6_client_fqdn.cc.

References domain_name_, domain_name_type_, isc::dhcp::Option6ClientFqdn::FULL, isc_throw, and isc::util::str::trim().

Referenced by operator=(), Option6ClientFqdnImpl(), and isc::dhcp::Option6ClientFqdn::setDomainName().

+ Here is the call graph for this function:

Member Data Documentation

◆ domain_name_

boost::shared_ptr<isc::dns::Name> isc::dhcp::Option6ClientFqdnImpl::domain_name_

◆ domain_name_type_

◆ flags_


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