Kea 3.3.3
isc::flex_option::FlexOptionImpl::OptionConfig Class Reference

Base option configuration. More...

#include <flex_option.h>

Inheritance diagram for isc::flex_option::FlexOptionImpl::OptionConfig:

Public Member Functions

 OptionConfig (uint16_t code, isc::dhcp::OptionDefinitionPtr def)
 Constructor.
virtual ~OptionConfig ()
 Destructor.
Action getAction () const
 Return action.
const isc::dhcp::ClientClass & getClass () const
 Get client class.
uint16_t getCode () const
 Return option code.
bool getDestination () const
 Get destination.
const isc::dhcp::ExpressionPtr & getExpr () const
 Get match expression.
isc::dhcp::OptionDefinitionPtr getOptionDef () const
 Return option definition.
bool getSource () const
 Get source.
const std::string & getText () const
 Get textual expression.
void setAction (Action action)
 Set action.
void setClass (const isc::dhcp::ClientClass &class_name)
 Set client class.
void setDestination (bool dest_is_response)
 Set destination.
void setExpr (const isc::dhcp::ExpressionPtr &expr)
 Set match expression.
void setSource (bool source_is_query)
 Set source.
void setText (const std::string &text)
 Set textual expression.

Detailed Description

Base option configuration.

Per option configuration.

Definition at line 57 of file flex_option.h.

Constructor & Destructor Documentation

◆ OptionConfig()

isc::flex_option::FlexOptionImpl::OptionConfig::OptionConfig ( uint16_t code,
isc::dhcp::OptionDefinitionPtr def )

Constructor.

Parameters
codethe option code.
defthe option definition.

Definition at line 107 of file flex_option.cc.

References isc::flex_option::FlexOptionImpl::NONE.

Referenced by isc::flex_option::FlexOptionImpl::SubOptionConfig::SubOptionConfig().

◆ ~OptionConfig()

isc::flex_option::FlexOptionImpl::OptionConfig::~OptionConfig ( )
virtual

Destructor.

Definition at line 113 of file flex_option.cc.

Member Function Documentation

◆ getAction()

Action isc::flex_option::FlexOptionImpl::OptionConfig::getAction ( ) const
inline

Return action.

Returns
action.

Definition at line 92 of file flex_option.h.

◆ getClass()

const isc::dhcp::ClientClass & isc::flex_option::FlexOptionImpl::OptionConfig::getClass ( ) const
inline

Get client class.

Returns
client class aka guard name.

Definition at line 134 of file flex_option.h.

◆ getCode()

uint16_t isc::flex_option::FlexOptionImpl::OptionConfig::getCode ( ) const
inline

Return option code.

Returns
option code.

Definition at line 71 of file flex_option.h.

◆ getDestination()

bool isc::flex_option::FlexOptionImpl::OptionConfig::getDestination ( ) const
inline

Get destination.

Returns
true if the destination is the response, false otherwise.

Definition at line 164 of file flex_option.h.

◆ getExpr()

const isc::dhcp::ExpressionPtr & isc::flex_option::FlexOptionImpl::OptionConfig::getExpr ( ) const
inline

Get match expression.

Returns
the match expression.

Definition at line 120 of file flex_option.h.

◆ getOptionDef()

isc::dhcp::OptionDefinitionPtr isc::flex_option::FlexOptionImpl::OptionConfig::getOptionDef ( ) const
inline

Return option definition.

Returns
option definition.

Definition at line 78 of file flex_option.h.

◆ getSource()

bool isc::flex_option::FlexOptionImpl::OptionConfig::getSource ( ) const
inline

Get source.

Returns
true if the source is the query, false otherwise.

Definition at line 149 of file flex_option.h.

◆ getText()

const std::string & isc::flex_option::FlexOptionImpl::OptionConfig::getText ( ) const
inline

Get textual expression.

Returns
textual expression.

Definition at line 106 of file flex_option.h.

◆ setAction()

void isc::flex_option::FlexOptionImpl::OptionConfig::setAction ( Action action)
inline

Set action.

Parameters
actionthe action.

Definition at line 85 of file flex_option.h.

◆ setClass()

void isc::flex_option::FlexOptionImpl::OptionConfig::setClass ( const isc::dhcp::ClientClass & class_name)
inline

Set client class.

Parameters
class_namethe client class aka guard name.

Definition at line 127 of file flex_option.h.

◆ setDestination()

void isc::flex_option::FlexOptionImpl::OptionConfig::setDestination ( bool dest_is_response)
inline

Set destination.

Parameters
dest_is_responsetrue if the destination is the response, false otherwise.

Definition at line 157 of file flex_option.h.

◆ setExpr()

void isc::flex_option::FlexOptionImpl::OptionConfig::setExpr ( const isc::dhcp::ExpressionPtr & expr)
inline

Set match expression.

Parameters
exprthe match expression.

Definition at line 113 of file flex_option.h.

◆ setSource()

void isc::flex_option::FlexOptionImpl::OptionConfig::setSource ( bool source_is_query)
inline

Set source.

Parameters
source_is_querytrue if the source is the query, false otherwise.

Definition at line 142 of file flex_option.h.

◆ setText()

void isc::flex_option::FlexOptionImpl::OptionConfig::setText ( const std::string & text)
inline

Set textual expression.

Parameters
textthe textual expression.

Definition at line 99 of file flex_option.h.


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