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_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 l2_binding &o)
	Copy Constructor. More...
	~l2_binding ()
	Destructor. More...
const key_t &	key () const
	Return the binding's key. More...
bool	operator== (const l2_binding &l) const
	Comparison operator - for UT. More...
std::shared_ptr< l2_binding >	singular () 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_binding >	find (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

typedef interface::key_t VOM::l2_binding::key_t

Key type for an L2 binding in the singular DB.

Definition at line 38 of file l2_binding.hpp.

Constructor & Destructor Documentation

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

Construct a new object matching the desried state.

Definition at line 61 of file l2_binding.cpp.

VOM::l2_binding::l2_binding

(

const l2_binding &

o

)

Copy Constructor.

Definition at line 70 of file l2_binding.cpp.

VOM::l2_binding::~l2_binding

(

)

Destructor.

Definition at line 125 of file l2_binding.cpp.

Member Function Documentation

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

static

Dump all l2_bindings into the stream provided.

Definition at line 197 of file l2_binding.cpp.

Here is the call graph for this function:

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 92 of file l2_binding.cpp.

Here is the call graph for this function:

const l2_binding::key_t & VOM::l2_binding::key

(

)

const

Return the binding's key.

Definition at line 80 of file l2_binding.cpp.

Here is the caller graph for this function:

bool VOM::l2_binding::operator==

(

const l2_binding &

l

)

const

Comparison operator - for UT.

Definition at line 86 of file l2_binding.cpp.

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 144 of file l2_binding.cpp.

Here is the call graph for this function:

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 191 of file l2_binding.cpp.

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

virtual

convert to string format for debug purposes

Implements VOM::object_base.

Definition at line 134 of file l2_binding.cpp.

Here is the call graph for this function:

Friends And Related Function Documentation

friend class OM

friend

Definition at line 159 of file l2_binding.hpp.

friend class singular_db< key_t, l2_binding >

friend

It's the singular_db class that calls replay()

Definition at line 164 of file l2_binding.hpp.

---

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

• src/vpp-api/vom/l2_binding.hpp
• src/vpp-api/vom/l2_binding.cpp