FD.io VPP  v20.05.1-6-gf53edbc3b
Vector Packet Processing
VOM::route_domain Class Reference

A route-domain is a VRF. More...

+ Inheritance diagram for VOM::route_domain:
+ Collaboration diagram for VOM::route_domain:

Public Types

typedef route::table_id_t key_t
 The Key for a route-domain. More...
 
typedef singular_db< const key_t, route_domain >::const_iterator const_iterator_t
 The iterator type. More...
 

Public Member Functions

 route_domain (route::table_id_t id)
 Construct a new object matching the desried state. More...
 
 route_domain (const route_domain &o)
 Copy Constructor. More...
 
 ~route_domain ()
 Destructor. More...
 
bool operator== (const route_domain &r) const
 comparison operator - for UT More...
 
std::shared_ptr< route_domainsingular () const
 Return the matching 'singular instance'. More...
 
std::string to_string () const
 Debug print function. More...
 
route::table_id_t table_id () const
 Get the table ID. More...
 
key_t key () const
 Get the route-domain's key. More...
 
void replay (void)
 replay the object to create it in hardware More...
 

Static Public Member Functions

static const_iterator_t cbegin ()
 
static const_iterator_t cend ()
 
static std::shared_ptr< route_domainfind (const key_t &temp)
 Find the instnace of the route domain in the OM. More...
 
static void dump (std::ostream &os)
 Dump all route-doamin into the stream provided. More...
 
static std::shared_ptr< route_domainget_default ()
 Return the sigular instance for the default table. More...
 

Friends

class OM
 
class singular_db< route::table_id_t, route_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 route-domain is a VRF.

creating a route-domain object will construct both an IPv4 and IPv6 table.

Definition at line 31 of file route_domain.hpp.

Member Typedef Documentation

◆ const_iterator_t

The iterator type.

Definition at line 43 of file route_domain.hpp.

◆ key_t

The Key for a route-domain.

Definition at line 37 of file route_domain.hpp.

Constructor & Destructor Documentation

◆ route_domain() [1/2]

VOM::route_domain::route_domain ( route::table_id_t  id)

Construct a new object matching the desried state.

Definition at line 33 of file route_domain.cpp.

◆ route_domain() [2/2]

VOM::route_domain::route_domain ( const route_domain o)

Copy Constructor.

Definition at line 40 of file route_domain.cpp.

◆ ~route_domain()

VOM::route_domain::~route_domain ( )

Destructor.

Definition at line 104 of file route_domain.cpp.

Member Function Documentation

◆ cbegin()

route_domain::const_iterator_t VOM::route_domain::cbegin ( )
static

Definition at line 66 of file route_domain.cpp.

+ Here is the caller graph for this function:

◆ cend()

route_domain::const_iterator_t VOM::route_domain::cend ( )
static

Definition at line 72 of file route_domain.cpp.

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

◆ dump()

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

Dump all route-doamin into the stream provided.

Definition at line 166 of file route_domain.cpp.

+ Here is the call graph for this function:

◆ find()

std::shared_ptr< route_domain > VOM::route_domain::find ( const key_t temp)
static

Find the instnace of the route domain in the OM.

Definition at line 124 of file route_domain.cpp.

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

◆ get_default()

std::shared_ptr< route_domain > VOM::route_domain::get_default ( )
static

Return the sigular instance for the default table.

Definition at line 146 of file route_domain.cpp.

◆ key()

route_domain::key_t VOM::route_domain::key ( ) const

Get the route-domain's key.

Definition at line 60 of file route_domain.cpp.

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

◆ operator==()

bool VOM::route_domain::operator== ( const route_domain r) const

comparison operator - for UT

Definition at line 48 of file route_domain.cpp.

◆ replay()

void VOM::route_domain::replay ( void  )
virtual

replay the object to create it in hardware

Implements VOM::object_base.

Definition at line 92 of file route_domain.cpp.

+ Here is the call graph for this function:

◆ singular()

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

Return the matching 'singular instance'.

Definition at line 160 of file route_domain.cpp.

◆ table_id()

route::table_id_t VOM::route_domain::table_id ( ) const

Get the table ID.

Definition at line 54 of file route_domain.cpp.

+ Here is the caller graph for this function:

◆ to_string()

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

Debug print function.

Implements VOM::object_base.

Definition at line 113 of file route_domain.cpp.

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

Friends And Related Function Documentation

◆ OM

friend class OM
friend

Definition at line 157 of file route_domain.hpp.

◆ singular_db< route::table_id_t, route_domain >

friend class singular_db< route::table_id_t, route_domain >
friend

It's the singular_db class that calls replay()

Definition at line 162 of file route_domain.hpp.


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