VOM::interface_span Class Reference

A representation of interface span configuration. More...

Inheritance diagram for VOM::interface_span:

Collaboration diagram for VOM::interface_span:

Data Structures
struct	state_t
	The state of the interface - rx/tx or both to be mirrored. More...

Public Types
typedef std::pair< interface::key_t, interface::key_t >	key_t
	The key type for interface_spans. More...

Public Member Functions
	interface_span (const interface &itf_from, const interface &itf_to, state_t state)
	Construct a new object matching the desried state. More...
	interface_span (const interface_span &o)
	Copy Constructor. More...
	~interface_span ()
	Destructor. More...
std::shared_ptr< interface_span >	singular () const
	Return the 'singular instance' of the interface_span that matches this object. More...
std::string	to_string () const
	convert to string format for debug purposes More...

Static Public Member Functions
static void	dump (std::ostream &os)
	Dump all interface_spans into the stream provided. More...
static std::shared_ptr< interface_span >	find (const interface &i)
	Find a singular instance in the DB for the interface passed. More...

Friends
class	OM
class	singular_db< key_t, interface_span >
	e* 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 representation of interface span configuration.

Definition at line 30 of file interface_span.hpp.

Member Typedef Documentation

typedef std::pair<interface::key_t, interface::key_t> VOM::interface_span::key_t

The key type for interface_spans.

Definition at line 106 of file interface_span.hpp.

Constructor & Destructor Documentation

VOM::interface_span::interface_span	(	const interface &	itf_from,
		const interface &	itf_to,
		interface_span::state_t	state
	)

Construct a new object matching the desried state.

Parameters

itf_from	- The interface to be mirrored
itf_to	- The interface where the traffic is mirrored

Definition at line 28 of file interface_span.cpp.

VOM::interface_span::interface_span

(

const interface_span &

o

)

Copy Constructor.

Definition at line 38 of file interface_span.cpp.

VOM::interface_span::~interface_span

(

)

Destructor.

Definition at line 46 of file interface_span.cpp.

Here is the call graph for this function:

Member Function Documentation

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

static

Dump all interface_spans into the stream provided.

Definition at line 65 of file interface_span.cpp.

Here is the call graph for this function:

static std::shared_ptr<interface_span> VOM::interface_span::find ( const interface &  i )

static

Find a singular instance in the DB for the interface passed.

std::shared_ptr< interface_span > VOM::interface_span::singular

(

)

const

Return the 'singular instance' of the interface_span that matches this object.

Definition at line 115 of file interface_span.cpp.

Here is the call graph for this function:

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

virtual

convert to string format for debug purposes

Implements VOM::object_base.

Definition at line 80 of file interface_span.cpp.

Here is the call graph for this function:

Friends And Related Function Documentation

friend class OM

friend

Definition at line 163 of file interface_span.hpp.

friend class singular_db< key_t, interface_span >

friend

e* It's the singular_db class that calls replay()

Definition at line 168 of file interface_span.hpp.

---

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

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