Kea  2.3.5-git
isc::dhcp::TemplateClientClassDef Class Reference

#include <client_class_def.h>

+ Inheritance diagram for isc::dhcp::TemplateClientClassDef:

Public Member Functions

 TemplateClientClassDef (const std::string &name, const ExpressionPtr &match_expr, const CfgOptionPtr &options=CfgOptionPtr())
 Constructor. More...
 
virtual void test (PktPtr pkt, const ExpressionPtr &expr_ptr) override
 Test method which checks if the packet belongs to the class. More...
 
virtual isc::data::ElementPtr toElement () const override
 Unparse a configuration object. More...
 
- Public Member Functions inherited from isc::dhcp::ClientClassDef
 ClientClassDef (const std::string &name, const ExpressionPtr &match_expr, const CfgOptionPtr &options=CfgOptionPtr())
 Constructor. More...
 
 ClientClassDef (const ClientClassDef &rhs)
 Copy constructor. More...
 
virtual ~ClientClassDef ()
 Destructor. More...
 
bool dependOnClass (const std::string &name) const
 Checks direct dependency. More...
 
bool equals (const ClientClassDef &other) const
 Compares two ClientClassDef objects for equality. More...
 
const CfgOptionPtrgetCfgOption () const
 Fetches the class's option collection. More...
 
const CfgOptionDefPtrgetCfgOptionDef () const
 Fetches the class's option definitions. More...
 
bool getDependOnKnown () const
 Fetches the depend on known flag aka use host flag. More...
 
const std::string & getFilename () const
 returns boot-file-name value More...
 
const ExpressionPtrgetMatchExpr () const
 Fetches the class's match expression. More...
 
std::string getName () const
 Fetches the class's name. More...
 
const asiolink::IOAddressgetNextServer () const
 returns next-server value More...
 
util::Triplet< uint32_t > getPreferred () const
 Return preferred-lifetime value. More...
 
bool getRequired () const
 Fetches the only if required flag. More...
 
const std::string & getSname () const
 returns server-hostname value More...
 
std::string getTest () const
 Fetches the class's original match expression. More...
 
util::Triplet< uint32_t > getValid () const
 Return valid-lifetime value. More...
 
bool operator!= (const ClientClassDef &other) const
 Inequality operator. More...
 
bool operator== (const ClientClassDef &other) const
 Equality operator. More...
 
void setCfgOption (const CfgOptionPtr &cfg_option)
 Sets the class's option collection. More...
 
void setCfgOptionDef (const CfgOptionDefPtr &cfg_option_def)
 Sets the class's option definition collection. More...
 
void setDependOnKnown (bool depend_on_known)
 Sets the depend on known flag aka use host flag. More...
 
void setFilename (const std::string &filename)
 sets the boot-file-name value More...
 
void setMatchExpr (const ExpressionPtr &match_expr)
 Sets the class's match expression. More...
 
void setName (const std::string &name)
 Sets the class's name. More...
 
void setNextServer (const asiolink::IOAddress &addr)
 sets the next-server value More...
 
void setPreferred (const util::Triplet< uint32_t > &preferred)
 Sets new preferred lifetime. More...
 
void setRequired (bool required)
 Sets the only if required flag. More...
 
void setSname (const std::string &sname)
 sets the server-name value More...
 
void setTest (const std::string &test)
 Sets the class's original match expression. More...
 
void setValid (const util::Triplet< uint32_t > &valid)
 Sets new valid lifetime. More...
 
- Public Member Functions inherited from isc::data::UserContext
void contextToElement (data::ElementPtr map) const
 Merge unparse a user_context object. More...
 
data::ConstElementPtr getContext () const
 Returns const pointer to the user context. More...
 
void setContext (const data::ConstElementPtr &ctx)
 Sets user context. More...
 
- Public Member Functions inherited from isc::data::CfgToElement
virtual ~CfgToElement ()
 Destructor. More...
 
- Public Member Functions inherited from isc::data::StampedElement
 StampedElement ()
 Constructor. More...
 
void delServerTag (const std::string &server_tag)
 Deletes server tag. More...
 
isc::data::ElementPtr getMetadata () const
 Returns an object representing metadata to be returned with objects from the configuration backend. More...
 
std::set< ServerTaggetServerTags () const
 Returns server tags. More...
 
bool hasAllServerTag () const
 Checks if the element has 'all' server tag. More...
 
bool hasServerTag (const ServerTag &server_tag) const
 Checks if the element has the given server tag. More...
 
void setServerTag (const std::string &server_tag)
 Adds new server tag. More...
 
- Public Member Functions inherited from isc::data::BaseStampedElement
 BaseStampedElement ()
 Constructor. More...
 
uint64_t getId () const
 Returns element's database identifier. More...
 
boost::posix_time::ptime getModificationTime () const
 Returns timestamp. More...
 
void setId (const uint64_t id)
 Sets element's database identifier. More...
 
void setModificationTime (const boost::posix_time::ptime &timestamp)
 Sets timestamp to the explicitly provided value. More...
 
void updateModificationTime ()
 Sets timestamp to the current time. More...
 

Static Public Attributes

static const std::string SPAWN_CLASS_PREFIX
 This is a prefix added to the spawned class name. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from isc::data::UserContext
static data::ElementPtr toElement (data::ConstElementPtr map)
 Copy an Element map. More...
 
- Protected Attributes inherited from isc::data::UserContext
data::ConstElementPtr user_context_
 Pointer to the user context (may be NULL) More...
 
- Protected Attributes inherited from isc::data::BaseStampedElement
uint64_t id_
 Database identifier of the configuration element. More...
 
boost::posix_time::ptime timestamp_
 Holds timestamp value. More...
 

Detailed Description

Definition at line 294 of file client_class_def.h.

Constructor & Destructor Documentation

◆ TemplateClientClassDef()

isc::dhcp::TemplateClientClassDef::TemplateClientClassDef ( const std::string &  name,
const ExpressionPtr match_expr,
const CfgOptionPtr options = CfgOptionPtr() 
)

Constructor.

Parameters
nameName to assign to this class
match_exprExpression the class will use to determine membership
optionsCollection of options members should be given

Definition at line 173 of file client_class_def.cc.

Member Function Documentation

◆ test()

void isc::dhcp::TemplateClientClassDef::test ( PktPtr  pkt,
const ExpressionPtr expr_ptr 
)
overridevirtual

Test method which checks if the packet belongs to the class.

If the packet belongs to the class, the class is added to the packet.

Parameters
pktThe packet checked if it belongs to the class.

Reimplemented from isc::dhcp::ClientClassDef.

Definition at line 180 of file client_class_def.cc.

References isc::dhcp::dhcpsrv_logger, isc::dhcp::EVAL_RESULT, isc::dhcp::evaluateString(), isc::dhcp::ClientClassDef::getName(), LOG_ERROR, LOG_INFO, and isc::Exception::what().

Referenced by toElement().

+ Here is the call graph for this function:

◆ toElement()

ElementPtr isc::dhcp::TemplateClientClassDef::toElement ( ) const
overridevirtual

Unparse a configuration object.

Returns
a pointer to unparsed configuration

Reimplemented from isc::dhcp::ClientClassDef.

Definition at line 301 of file client_class_def.cc.

References isc::data::Element::create(), test(), and isc::dhcp::ClientClassDef::toElement().

+ Here is the call graph for this function:

Member Data Documentation

◆ SPAWN_CLASS_PREFIX

const std::string isc::dhcp::TemplateClientClassDef::SPAWN_CLASS_PREFIX
static

This is a prefix added to the spawned class name.

If incoming packet is associated with the template class, the name of generated spawned class is prepended with this prefix. For example, a packet that associates with the template class "FOO" by evaluating the template class expression to BAR will cause the packet to be assigned to class SPAWN_FOO_BAR.

Definition at line 323 of file client_class_def.h.

Referenced by isc::dhcp::ClientClassDef::test().


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