FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
VOM::l2_binding Class Reference

A Clas representing the binding of an L2 interface to a bridge-domain and the properties of that binding. More...

+ Inheritance diagram for VOM::l2_binding:
+ Collaboration diagram for VOM::l2_binding:

Data Structures

struct  l2_port_type_t
 
struct  l2_vtr_op_t
 

Public Types

typedef interface::key_t key_t
 Key type for an L2 binding in the singular DB. More...
 

Public Member Functions

 l2_binding (const interface &itf, const bridge_domain &bd)
 Construct a new object matching the desried state. More...
 
 l2_binding (const interface &itf, const bridge_domain &bd, const l2_port_type_t &port_type)
 Construct a new object matching the desried state. More...
 
 l2_binding (const l2_binding &o)
 Copy Constructor. More...
 
 ~l2_binding ()
 Destructor. More...
 
const key_tkey () const
 Return the binding's key. More...
 
bool operator== (const l2_binding &l) const
 Comparison operator - for UT. More...
 
std::shared_ptr< l2_bindingsingular () const
 Return the 'singular instance' of the L2 config that matches this object. More...
 
std::string to_string () const
 convert to string format for debug purposes More...
 
void set (const l2_vtr_op_t &op, uint16_t tag)
 Set the VTR operation on the binding/interface. More...
 

Static Public Member Functions

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

Friends

class OM
 
class singular_db< key_t, l2_binding >
 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 Clas representing the binding of an L2 interface to a bridge-domain and the properties of that binding.

Definition at line 32 of file l2_binding.hpp.

Member Typedef Documentation

◆ key_t

Key type for an L2 binding in the singular DB.

Definition at line 38 of file l2_binding.hpp.

Constructor & Destructor Documentation

◆ l2_binding() [1/3]

VOM::l2_binding::l2_binding ( const interface itf,
const bridge_domain bd 
)

Construct a new object matching the desried state.

Definition at line 74 of file l2_binding.cpp.

◆ l2_binding() [2/3]

VOM::l2_binding::l2_binding ( const interface itf,
const bridge_domain bd,
const l2_port_type_t port_type 
)

Construct a new object matching the desried state.

Definition at line 89 of file l2_binding.cpp.

◆ l2_binding() [3/3]

VOM::l2_binding::l2_binding ( const l2_binding o)

Copy Constructor.

Definition at line 101 of file l2_binding.cpp.

◆ ~l2_binding()

VOM::l2_binding::~l2_binding ( )

Destructor.

Definition at line 156 of file l2_binding.cpp.

Member Function Documentation

◆ dump()

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

Dump all l2_bindings into the stream provided.

Definition at line 225 of file l2_binding.cpp.

+ Here is the call graph for this function:

◆ find()

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

Static function to find the bridge_domain in the model.

Definition at line 125 of file l2_binding.cpp.

+ Here is the call graph for this function:

◆ key()

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

Return the binding's key.

Definition at line 112 of file l2_binding.cpp.

+ Here is the caller graph for this function:

◆ operator==()

bool VOM::l2_binding::operator== ( const l2_binding l) const

Comparison operator - for UT.

Definition at line 118 of file l2_binding.cpp.

◆ set()

void VOM::l2_binding::set ( const l2_vtr_op_t op,
uint16_t  tag 
)

Set the VTR operation on the binding/interface.

Definition at line 175 of file l2_binding.cpp.

+ Here is the call graph for this function:

◆ singular()

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

Return the 'singular instance' of the L2 config that matches this object.

Definition at line 219 of file l2_binding.cpp.

◆ to_string()

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

convert to string format for debug purposes

Implements VOM::object_base.

Definition at line 165 of file l2_binding.cpp.

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ OM

friend class OM
friend

Definition at line 175 of file l2_binding.hpp.

◆ singular_db< key_t, l2_binding >

friend class singular_db< key_t, l2_binding >
friend

It's the singular_db class that calls replay()

Definition at line 180 of file l2_binding.hpp.


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