FD.io VPP  v21.01.1
Vector Packet Processing
VOM::gbp_endpoint_group Class Reference

A entry in the ARP termination table of a Bridge Domain. More...

+ Inheritance diagram for VOM::gbp_endpoint_group:
+ Collaboration diagram for VOM::gbp_endpoint_group:

Data Structures

struct  retention_t
 Endpoint Retention Policy Settings. More...
 

Public Types

typedef sclass_t key_t
 The key for a GBP endpoint group is its ID. More...
 

Public Member Functions

 gbp_endpoint_group (vnid_t vnid, sclass_t sclass, const interface &itf, const gbp_route_domain &rd, const gbp_bridge_domain &bd)
 Construct a GBP endpoint_group. More...
 
 gbp_endpoint_group (vnid_t vnid, sclass_t sclass, const gbp_route_domain &rd, const gbp_bridge_domain &bd)
 
 gbp_endpoint_group (sclass_t sclass, const gbp_route_domain &rd, const gbp_bridge_domain &bd)
 
 gbp_endpoint_group (const gbp_endpoint_group &r)
 Copy Construct. More...
 
 ~gbp_endpoint_group ()
 Destructor. More...
 
const key_t key () const
 Return the object's key. More...
 
bool operator== (const gbp_endpoint_group &bdae) const
 comparison operator More...
 
std::shared_ptr< gbp_endpoint_groupsingular () 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...
 
vnid_t vnid () const
 Get the ID of the EPG. More...
 
sclass_t sclass () const
 
const std::shared_ptr< gbp_route_domainget_route_domain () const
 
const std::shared_ptr< gbp_bridge_domainget_bridge_domain () const
 
void set (const retention_t &retention)
 

Static Public Member Functions

static std::shared_ptr< gbp_endpoint_groupfind (const key_t &k)
 Find the instnace of the bridge_domain domain in the OM. More...
 
static void dump (std::ostream &os)
 Dump all bridge_domain-doamin into the stream provided. More...
 

Friends

class OM
 
class singular_db< key_t, gbp_endpoint_group >
 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 entry in the ARP termination table of a Bridge Domain.

Definition at line 32 of file gbp_endpoint_group.hpp.

Member Typedef Documentation

◆ key_t

The key for a GBP endpoint group is its ID.

Definition at line 58 of file gbp_endpoint_group.hpp.

Constructor & Destructor Documentation

◆ gbp_endpoint_group() [1/4]

VOM::gbp_endpoint_group::gbp_endpoint_group ( vnid_t  vnid,
sclass_t  sclass,
const interface itf,
const gbp_route_domain rd,
const gbp_bridge_domain bd 
)

Construct a GBP endpoint_group.

Definition at line 48 of file gbp_endpoint_group.cpp.

◆ gbp_endpoint_group() [2/4]

VOM::gbp_endpoint_group::gbp_endpoint_group ( vnid_t  vnid,
sclass_t  sclass,
const gbp_route_domain rd,
const gbp_bridge_domain bd 
)

Definition at line 63 of file gbp_endpoint_group.cpp.

◆ gbp_endpoint_group() [3/4]

VOM::gbp_endpoint_group::gbp_endpoint_group ( sclass_t  sclass,
const gbp_route_domain rd,
const gbp_bridge_domain bd 
)

Definition at line 77 of file gbp_endpoint_group.cpp.

◆ gbp_endpoint_group() [4/4]

VOM::gbp_endpoint_group::gbp_endpoint_group ( const gbp_endpoint_group r)

Copy Construct.

Definition at line 90 of file gbp_endpoint_group.cpp.

◆ ~gbp_endpoint_group()

VOM::gbp_endpoint_group::~gbp_endpoint_group ( )

Destructor.

Definition at line 101 of file gbp_endpoint_group.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ dump()

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

Dump all bridge_domain-doamin into the stream provided.

Definition at line 200 of file gbp_endpoint_group.cpp.

+ Here is the call graph for this function:

◆ find()

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

Find the instnace of the bridge_domain domain in the OM.

Definition at line 188 of file gbp_endpoint_group.cpp.

+ Here is the caller graph for this function:

◆ get_bridge_domain()

const std::shared_ptr< gbp_bridge_domain > VOM::gbp_endpoint_group::get_bridge_domain ( ) const

Definition at line 212 of file gbp_endpoint_group.cpp.

+ Here is the call graph for this function:

◆ get_route_domain()

const std::shared_ptr< gbp_route_domain > VOM::gbp_endpoint_group::get_route_domain ( ) const

Definition at line 206 of file gbp_endpoint_group.cpp.

◆ key()

const gbp_endpoint_group::key_t VOM::gbp_endpoint_group::key ( ) const

Return the object's key.

Definition at line 108 of file gbp_endpoint_group.cpp.

+ Here is the caller graph for this function:

◆ operator==()

bool VOM::gbp_endpoint_group::operator== ( const gbp_endpoint_group bdae) const

comparison operator

Definition at line 132 of file gbp_endpoint_group.cpp.

+ Here is the call graph for this function:

◆ replay()

void VOM::gbp_endpoint_group::replay ( void  )
virtual

replay the object to create it in hardware

Implements VOM::object_base.

Definition at line 149 of file gbp_endpoint_group.cpp.

+ Here is the call graph for this function:

◆ sclass()

sclass_t VOM::gbp_endpoint_group::sclass ( ) const

Definition at line 126 of file gbp_endpoint_group.cpp.

◆ set()

void VOM::gbp_endpoint_group::set ( const retention_t retention)

Definition at line 120 of file gbp_endpoint_group.cpp.

◆ singular()

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

Return the matching 'singular instance'.

Definition at line 194 of file gbp_endpoint_group.cpp.

◆ to_string()

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

Convert to string for debugging.

Implements VOM::object_base.

Definition at line 159 of file gbp_endpoint_group.cpp.

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

◆ vnid()

vnid_t VOM::gbp_endpoint_group::vnid ( ) const

Get the ID of the EPG.

Definition at line 114 of file gbp_endpoint_group.cpp.

Friends And Related Function Documentation

◆ OM

friend class OM
friend

Definition at line 182 of file gbp_endpoint_group.hpp.

◆ singular_db< key_t, gbp_endpoint_group >

friend class singular_db< key_t, gbp_endpoint_group >
friend

It's the singular_db class that calls replay()

Definition at line 187 of file gbp_endpoint_group.hpp.


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