FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
VOM::lldp_global Class Reference

A representation of LLDP global configuration. More...

+ Inheritance diagram for VOM::lldp_global:
+ Collaboration diagram for VOM::lldp_global:

Public Types

typedef std::string key_t
 The key for the global conifugration is the 'system' namse. More...
 

Public Member Functions

 lldp_global (const std::string &system_name, uint32_t tx_hold, uint32_t tx_interval)
 Construct a new object matching the desried state. More...
 
 lldp_global (const lldp_global &o)
 Copy Constructor. More...
 
 ~lldp_global ()
 Destructor. More...
 
const key_tkey () const
 Get this objects key. More...
 
bool operator== (const lldp_global &l) const
 Comparison operator. More...
 
std::shared_ptr< lldp_globalsingular () const
 Return the 'singular' of the LLDP global 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 LLDP globals into the stream provided. More...
 
static std::shared_ptr< lldp_globalfind (const key_t &k)
 Find LLDP global config from its key. More...
 

Friends

class OM
 
class singular_db< key_t, lldp_global >
 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 LLDP global configuration.

Definition at line 29 of file lldp_global.hpp.

Member Typedef Documentation

◆ key_t

typedef std::string VOM::lldp_global::key_t

The key for the global conifugration is the 'system' namse.

Definition at line 35 of file lldp_global.hpp.

Constructor & Destructor Documentation

◆ lldp_global() [1/2]

VOM::lldp_global::lldp_global ( const std::string &  system_name,
uint32_t  tx_hold,
uint32_t  tx_interval 
)

Construct a new object matching the desried state.

Definition at line 28 of file lldp_global.cpp.

◆ lldp_global() [2/2]

VOM::lldp_global::lldp_global ( const lldp_global o)

Copy Constructor.

Definition at line 37 of file lldp_global.cpp.

◆ ~lldp_global()

VOM::lldp_global::~lldp_global ( )

Destructor.

Definition at line 44 of file lldp_global.cpp.

Member Function Documentation

◆ dump()

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

Dump all LLDP globals into the stream provided.

Definition at line 72 of file lldp_global.cpp.

+ Here is the call graph for this function:

◆ find()

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

Find LLDP global config from its key.

Definition at line 113 of file lldp_global.cpp.

◆ key()

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

Get this objects key.

Definition at line 53 of file lldp_global.cpp.

+ Here is the caller graph for this function:

◆ operator==()

bool VOM::lldp_global::operator== ( const lldp_global l) const

Comparison operator.

Definition at line 59 of file lldp_global.cpp.

+ Here is the call graph for this function:

◆ singular()

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

Return the 'singular' of the LLDP global that matches this object.

Definition at line 119 of file lldp_global.cpp.

+ Here is the call graph for this function:

◆ to_string()

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

convert to string format for debug purposes

Implements VOM::object_base.

Definition at line 87 of file lldp_global.cpp.

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ OM

friend class OM
friend

Definition at line 133 of file lldp_global.hpp.

◆ singular_db< key_t, lldp_global >

friend class singular_db< key_t, lldp_global >
friend

It's the singular_db class that calls replay()

Definition at line 138 of file lldp_global.hpp.


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