FD.io VPP  v18.01-8-g0eacf49
Vector Packet Processing
VOM::dhcp_config Class Reference

A representation of DHCP client configuration on an interface. More...

+ Inheritance diagram for VOM::dhcp_config:
+ Collaboration diagram for VOM::dhcp_config:

Data Structures

class  event_listener
 A class that listens to DHCP Events. More...
 

Public Types

typedef interface::key_t key_t
 typedef for the DHCP config key type More...
 

Public Member Functions

 dhcp_config (const interface &itf, const std::string &hostname)
 Construct a new object matching the desried state. More...
 
 dhcp_config (const interface &itf, const std::string &hostname, const l2_address_t &client_id)
 Construct a new object matching the desried state. More...
 
 dhcp_config (const dhcp_config &o)
 Copy Constructor. More...
 
 ~dhcp_config ()
 Destructor. More...
 
bool operator== (const dhcp_config &d) const
 Comparison operator - for UT. More...
 
const key_tkey () const
 Return the object's key. More...
 
std::shared_ptr< dhcp_configsingular () const
 Return the 'singular' of the DHCP config that matches this object. More...
 
std::string to_string () const
 convert to string format for debug purposes More...
 

Static Public Member Functions

static void dump (std::ostream &os)
 Dump all DHCP configs into the stream provided. More...
 
static std::shared_ptr< dhcp_configfind (const key_t &k)
 Find a DHCP config from its key. More...
 

Friends

class OM
 
class singular_db< key_t, dhcp_config >
 It's the singular_db class that calls replay() More...
 

Additional Inherited Members

- Protected Member Functions inherited from VOM::object_base
 object_base ()=default
 Constructable by derived classes only. More...
 
virtual ~object_base ()=default
 Destructor. More...
 

Detailed Description

A representation of DHCP client configuration on an interface.

Definition at line 33 of file dhcp_config.hpp.

Member Typedef Documentation

typedef for the DHCP config key type

Definition at line 39 of file dhcp_config.hpp.

Constructor & Destructor Documentation

VOM::dhcp_config::dhcp_config ( const interface itf,
const std::string &  hostname 
)

Construct a new object matching the desried state.

Definition at line 27 of file dhcp_config.cpp.

VOM::dhcp_config::dhcp_config ( const interface itf,
const std::string &  hostname,
const l2_address_t client_id 
)

Construct a new object matching the desried state.

Definition at line 35 of file dhcp_config.cpp.

VOM::dhcp_config::dhcp_config ( const dhcp_config o)

Copy Constructor.

Definition at line 45 of file dhcp_config.cpp.

VOM::dhcp_config::~dhcp_config ( )

Destructor.

Definition at line 53 of file dhcp_config.cpp.

Member Function Documentation

void VOM::dhcp_config::dump ( std::ostream &  os)
static

Dump all DHCP configs into the stream provided.

Definition at line 85 of file dhcp_config.cpp.

+ Here is the call graph for this function:

std::shared_ptr< dhcp_config > VOM::dhcp_config::find ( const key_t k)
static

Find a DHCP config from its key.

Definition at line 128 of file dhcp_config.cpp.

const dhcp_config::key_t & VOM::dhcp_config::key ( ) const

Return the object's key.

Definition at line 69 of file dhcp_config.cpp.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool VOM::dhcp_config::operator== ( const dhcp_config d) const

Comparison operator - for UT.

Definition at line 62 of file dhcp_config.cpp.

+ Here is the call graph for this function:

std::shared_ptr< dhcp_config > VOM::dhcp_config::singular ( ) const

Return the 'singular' of the DHCP config that matches this object.

Definition at line 134 of file dhcp_config.cpp.

std::string VOM::dhcp_config::to_string ( void  ) const
virtual

convert to string format for debug purposes

Implements VOM::object_base.

Definition at line 100 of file dhcp_config.cpp.

+ Here is the call graph for this function:

Friends And Related Function Documentation

friend class OM
friend

Definition at line 171 of file dhcp_config.hpp.

friend class singular_db< key_t, dhcp_config >
friend

It's the singular_db class that calls replay()

Definition at line 176 of file dhcp_config.hpp.


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