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

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

+ Inheritance diagram for VOM::bridge_domain_arp_entry:
+ Collaboration diagram for VOM::bridge_domain_arp_entry:

Public Types

typedef std::pair< bridge_domain::key_t, boost::asio::ip::addresskey_t
 The key for a bridge_domain ARP entry; the BD, IP address and MAC address. More...
 

Public Member Functions

 bridge_domain_arp_entry (const bridge_domain &bd, const boost::asio::ip::address &ip_addr, const mac_address_t &mac)
 Construct a bridge domain ARP Entry in the given bridge domain. More...
 
 bridge_domain_arp_entry (const boost::asio::ip::address &ip_addr, const mac_address_t &mac)
 Construct a bridge domain ARP entry in the default table. More...
 
 bridge_domain_arp_entry (const bridge_domain_arp_entry &r)
 Copy Construct. More...
 
 ~bridge_domain_arp_entry ()
 Destructor. More...
 
const key_t key () const
 Return the object's key. More...
 
bool operator== (const bridge_domain_arp_entry &bdae) const
 comparison operator More...
 
std::shared_ptr< bridge_domain_arp_entrysingular () 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...
 

Static Public Member Functions

static std::shared_ptr< bridge_domain_arp_entryfind (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, bridge_domain_arp_entry >
 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 28 of file bridge_domain_arp_entry.hpp.

Member Typedef Documentation

◆ key_t

The key for a bridge_domain ARP entry; the BD, IP address and MAC address.

Definition at line 35 of file bridge_domain_arp_entry.hpp.

Constructor & Destructor Documentation

◆ bridge_domain_arp_entry() [1/3]

VOM::bridge_domain_arp_entry::bridge_domain_arp_entry ( const bridge_domain bd,
const boost::asio::ip::address ip_addr,
const mac_address_t mac 
)

Construct a bridge domain ARP Entry in the given bridge domain.

Definition at line 28 of file bridge_domain_arp_entry.cpp.

◆ bridge_domain_arp_entry() [2/3]

VOM::bridge_domain_arp_entry::bridge_domain_arp_entry ( const boost::asio::ip::address ip_addr,
const mac_address_t mac 
)

Construct a bridge domain ARP entry in the default table.

Definition at line 39 of file bridge_domain_arp_entry.cpp.

+ Here is the call graph for this function:

◆ bridge_domain_arp_entry() [3/3]

VOM::bridge_domain_arp_entry::bridge_domain_arp_entry ( const bridge_domain_arp_entry r)

Copy Construct.

Definition at line 55 of file bridge_domain_arp_entry.cpp.

◆ ~bridge_domain_arp_entry()

VOM::bridge_domain_arp_entry::~bridge_domain_arp_entry ( )

Destructor.

Definition at line 64 of file bridge_domain_arp_entry.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ dump()

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

Dump all bridge_domain-doamin into the stream provided.

Definition at line 144 of file bridge_domain_arp_entry.cpp.

+ Here is the call graph for this function:

◆ find()

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

Find the instnace of the bridge_domain domain in the OM.

Definition at line 132 of file bridge_domain_arp_entry.cpp.

◆ key()

const bridge_domain_arp_entry::key_t VOM::bridge_domain_arp_entry::key ( ) const

Return the object's key.

Definition at line 73 of file bridge_domain_arp_entry.cpp.

+ Here is the caller graph for this function:

◆ operator==()

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

comparison operator

Definition at line 79 of file bridge_domain_arp_entry.cpp.

+ Here is the call graph for this function:

◆ replay()

void VOM::bridge_domain_arp_entry::replay ( void  )
virtual

replay the object to create it in hardware

Implements VOM::object_base.

Definition at line 95 of file bridge_domain_arp_entry.cpp.

+ Here is the call graph for this function:

◆ singular()

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

Return the matching 'singular instance'.

Definition at line 138 of file bridge_domain_arp_entry.cpp.

◆ to_string()

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

Convert to string for debugging.

Implements VOM::object_base.

Definition at line 104 of file bridge_domain_arp_entry.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 145 of file bridge_domain_arp_entry.hpp.

◆ singular_db< key_t, bridge_domain_arp_entry >

friend class singular_db< key_t, bridge_domain_arp_entry >
friend

It's the singular_db class that calls replay()

Definition at line 150 of file bridge_domain_arp_entry.hpp.


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