FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
VOM::bridge_domain Class Reference

A base class for all object_base in the VPP object_base-Model. More...

+ Inheritance diagram for VOM::bridge_domain:
+ Collaboration diagram for VOM::bridge_domain:

Data Structures

struct  arp_term_mode_t
 Bridge Domain ARP termination mode. More...
 
struct  arp_ufwd_mode_t
 Bridge Domain ARP Unicast Forward mode. More...
 
struct  flood_mode_t
 Bridge Domain flood mode. More...
 
struct  learning_mode_t
 Bridge Domain Learning mode. More...
 
struct  mac_age_mode_t
 Bridge Domain MAC aging mode. More...
 
struct  uu_flood_mode_t
 Bridge Domain Unknown Unicast Flood mode. More...
 

Public Types

typedef uint32_t key_t
 Key Type for Bridge Domains in the sigular DB. More...
 

Public Member Functions

 bridge_domain (uint32_t id, const learning_mode_t &lmode=learning_mode_t::ON, const arp_term_mode_t &amode=arp_term_mode_t::ON, const arp_ufwd_mode_t &aumode=arp_ufwd_mode_t::OFF, const flood_mode_t &fmode=flood_mode_t::ON, const uu_flood_mode_t &uufmode=uu_flood_mode_t::ON, const mac_age_mode_t &mmode=mac_age_mode_t::OFF)
 Construct a new object matching the desried state. More...
 
 bridge_domain (const bridge_domain &o)
 Copy Constructor. More...
 
 ~bridge_domain ()
 Destructor. More...
 
bool operator== (const bridge_domain &b) const
 Comparison operator - for UT. More...
 
uint32_t id () const
 Return the bridge domain's VPP ID. More...
 
const key_tkey () const
 Return the bridge domain's key. More...
 
std::shared_ptr< bridge_domainsingular () const
 Return the matchin 'singular' instance of the bridge-domain. More...
 
std::string to_string (void) const
 convert to string format for debug purposes More...
 

Static Public Member Functions

static std::shared_ptr< bridge_domainfind (const key_t &key)
 Static function to find the bridge_domain in the model. More...
 
static void dump (std::ostream &os)
 Dump all bridge-doamin into the stream provided. More...
 

Static Public Attributes

const static uint32_t DEFAULT_TABLE = 0
 The value of the defaultbridge domain. More...
 

Friends

class OM
 
class singular_db< key_t, bridge_domain >
 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 base class for all object_base in the VPP object_base-Model.

provides the abstract interface.

Definition at line 31 of file bridge_domain.hpp.

Member Typedef Documentation

◆ key_t

typedef uint32_t VOM::bridge_domain::key_t

Key Type for Bridge Domains in the sigular DB.

Definition at line 37 of file bridge_domain.hpp.

Constructor & Destructor Documentation

◆ bridge_domain() [1/2]

VOM::bridge_domain::bridge_domain ( uint32_t  id,
const learning_mode_t lmode = learning_mode_t::ON,
const arp_term_mode_t amode = arp_term_mode_t::ON,
const arp_ufwd_mode_t aumode = arp_ufwd_mode_t::OFF,
const flood_mode_t fmode = flood_mode_t::ON,
const uu_flood_mode_t uufmode = uu_flood_mode_t::ON,
const mac_age_mode_t mmode = mac_age_mode_t::OFF 
)

Construct a new object matching the desried state.

Definition at line 91 of file bridge_domain.cpp.

◆ bridge_domain() [2/2]

VOM::bridge_domain::bridge_domain ( const bridge_domain o)

Copy Constructor.

Definition at line 108 of file bridge_domain.cpp.

◆ ~bridge_domain()

VOM::bridge_domain::~bridge_domain ( )

Destructor.

Definition at line 161 of file bridge_domain.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ dump()

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

Dump all bridge-doamin into the stream provided.

Definition at line 211 of file bridge_domain.cpp.

+ Here is the call graph for this function:

◆ find()

std::shared_ptr< bridge_domain > VOM::bridge_domain::find ( const key_t key)
static

Static function to find the bridge_domain in the model.

Definition at line 180 of file bridge_domain.cpp.

+ Here is the call graph for this function:

◆ id()

uint32_t VOM::bridge_domain::id ( ) const

Return the bridge domain's VPP ID.

Definition at line 126 of file bridge_domain.cpp.

+ Here is the call graph for this function:

◆ key()

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

Return the bridge domain's key.

Definition at line 120 of file bridge_domain.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator==()

bool VOM::bridge_domain::operator== ( const bridge_domain b) const

Comparison operator - for UT.

Definition at line 132 of file bridge_domain.cpp.

◆ singular()

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

Return the matchin 'singular' instance of the bridge-domain.

Definition at line 205 of file bridge_domain.cpp.

+ Here is the caller graph for this function:

◆ to_string()

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

convert to string format for debug purposes

Implements VOM::object_base.

Definition at line 170 of file bridge_domain.cpp.

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ OM

friend class OM
friend

Definition at line 239 of file bridge_domain.hpp.

◆ singular_db< key_t, bridge_domain >

friend class singular_db< key_t, bridge_domain >
friend

It's the singular_db class that calls replay()

Definition at line 244 of file bridge_domain.hpp.

Field Documentation

◆ DEFAULT_TABLE

const static uint32_t VOM::bridge_domain::DEFAULT_TABLE = 0
static

The value of the defaultbridge domain.

Definition at line 132 of file bridge_domain.hpp.


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