FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
VOM::route::ip_mroute Class Reference

A IP multicast route. More...

+ Inheritance diagram for VOM::route::ip_mroute:
+ Collaboration diagram for VOM::route::ip_mroute:

Public Types

typedef std::pair< route::table_id_t, mprefix_tkey_t
 The key for a route. More...
 

Public Member Functions

 ip_mroute (const mprefix_t &mprefix)
 Construct a route in the default table. More...
 
 ip_mroute (const ip_mroute &r)
 Copy Construct. More...
 
 ip_mroute (const route_domain &rd, const mprefix_t &mprefix)
 Construct a route in the given route domain. More...
 
 ~ip_mroute ()
 Destructor. More...
 
const key_t key () const
 Get the route's key. More...
 
bool operator== (const ip_mroute &i) const
 Comparison operator. More...
 
std::shared_ptr< ip_mroutesingular () const
 Return the matching 'singular instance'. More...
 
void replay (void)
 replay the object to create it in hardware More...
 
std::string to_string () const
 Convert to string for debugging. More...
 
void add (const path &path, const itf_flags_t &flag)
 

Static Public Member Functions

static std::shared_ptr< ip_mroutefind (const ip_mroute &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< ip_mroutefind (const key_t &k)
 Return the matching 'singular instance'. More...
 

Friends

class VOM::OM
 
class singular_db< key_t, ip_mroute >
 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 IP multicast route.

Definition at line 425 of file route.hpp.

Member Typedef Documentation

◆ key_t

The key for a route.

Definition at line 431 of file route.hpp.

Constructor & Destructor Documentation

◆ ip_mroute() [1/3]

VOM::route::ip_mroute::ip_mroute ( const mprefix_t mprefix)

Construct a route in the default table.

Definition at line 464 of file route.cpp.

◆ ip_mroute() [2/3]

VOM::route::ip_mroute::ip_mroute ( const ip_mroute r)

Copy Construct.

Definition at line 472 of file route.cpp.

◆ ip_mroute() [3/3]

VOM::route::ip_mroute::ip_mroute ( const route_domain rd,
const mprefix_t mprefix 
)

Construct a route in the given route domain.

Definition at line 480 of file route.cpp.

◆ ~ip_mroute()

VOM::route::ip_mroute::~ip_mroute ( )

Destructor.

Definition at line 494 of file route.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ add()

void VOM::route::ip_mroute::add ( const path path,
const itf_flags_t flag 
)

Definition at line 489 of file route.cpp.

◆ dump()

void VOM::route::ip_mroute::dump ( std::ostream &  os)
static

Dump all route-doamin into the stream provided.

Definition at line 572 of file route.cpp.

+ Here is the call graph for this function:

◆ find() [1/2]

static std::shared_ptr<ip_mroute> VOM::route::ip_mroute::find ( const ip_mroute temp)
static

Find the instnace of the route domain in the OM.

◆ find() [2/2]

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

Return the matching 'singular instance'.

Definition at line 560 of file route.cpp.

◆ key()

const ip_mroute::key_t VOM::route::ip_mroute::key ( ) const

Get the route's key.

Definition at line 501 of file route.cpp.

+ Here is the caller graph for this function:

◆ operator==()

bool VOM::route::ip_mroute::operator== ( const ip_mroute i) const

Comparison operator.

Definition at line 507 of file route.cpp.

+ Here is the call graph for this function:

◆ replay()

void VOM::route::ip_mroute::replay ( void  )
virtual

replay the object to create it in hardware

Implements VOM::object_base.

Definition at line 524 of file route.cpp.

+ Here is the call graph for this function:

◆ singular()

std::shared_ptr< ip_mroute > VOM::route::ip_mroute::singular ( ) const

Return the matching 'singular instance'.

Definition at line 566 of file route.cpp.

◆ to_string()

std::string VOM::route::ip_mroute::to_string ( ) const
virtual

Convert to string for debugging.

Implements VOM::object_base.

Definition at line 533 of file route.cpp.

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ singular_db< key_t, ip_mroute >

friend class singular_db< key_t, ip_mroute >
friend

It's the singular_db class that calls replay()

Definition at line 544 of file route.hpp.

◆ VOM::OM

friend class VOM::OM
friend

Definition at line 539 of file route.hpp.


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