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

Represents configuration of the RSOO options for the DHCP server. More...

#include <cfg_rsoo.h>

+ Inheritance diagram for isc::dhcp::CfgRSOO:

Public Member Functions

 CfgRSOO ()
 Constructor. More...
 
void clear ()
 Removes designation of all options as RSOO_enabled. More...
 
void enable (const uint16_t code)
 Marks specified option code as RSOO-enabled. More...
 
bool enabled (const uint16_t code) const
 Returns whether specific option code is RSOO-enabled. More...
 
virtual isc::data::ElementPtr toElement () const
 Unparse a configuration object. More...
 
- Public Member Functions inherited from isc::data::CfgToElement
virtual ~CfgToElement ()
 Destructor. More...
 

Detailed Description

Represents configuration of the RSOO options for the DHCP server.

This class holds the set of RSOO-enabled options (see RFC6422). The list of RSOO-enabled options is maintained by IANA and currently the option 65 is officially RSSO-enabled. The list may be extended in the future and this class allows for specifying any future RSOO-enabled options. The administrator may also use existing options as RSOO-enabled.

Definition at line 25 of file cfg_rsoo.h.

Constructor & Destructor Documentation

◆ CfgRSOO()

isc::dhcp::CfgRSOO::CfgRSOO ( )

Constructor.

It adds the default (officially) RSOO-enabled options:

  • OPTION_ERP_LOCAL_DOMAIN_NAME

Definition at line 18 of file cfg_rsoo.cc.

References D6O_ERP_LOCAL_DOMAIN_NAME.

Member Function Documentation

◆ clear()

void isc::dhcp::CfgRSOO::clear ( )

Removes designation of all options as RSOO_enabled.

This method removes all designations of all options as being RSOO-enabled.

Definition at line 24 of file cfg_rsoo.cc.

◆ enable()

void isc::dhcp::CfgRSOO::enable ( const uint16_t  code)

Marks specified option code as RSOO-enabled.

Parameters
codeoption to be enabled in RSOO

Definition at line 34 of file cfg_rsoo.cc.

◆ enabled()

bool isc::dhcp::CfgRSOO::enabled ( const uint16_t  code) const

Returns whether specific option code is RSOO-enabled.

Parameters
codeOption code to check
Returns
true, if it is allowed in Relay-Supplied Options option

Definition at line 29 of file cfg_rsoo.cc.

◆ toElement()

ElementPtr isc::dhcp::CfgRSOO::toElement ( ) const
virtual

Unparse a configuration object.

Returns
a pointer to unparsed configuration

Implements isc::data::CfgToElement.

Definition at line 42 of file cfg_rsoo.cc.


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