VOM::nat_binding Class Reference

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

Inheritance diagram for VOM::nat_binding:

Collaboration diagram for VOM::nat_binding:

Data Structures
struct	zone_t
	NAT Zoness. More...

Public Types
typedef std::tuple< interface::key_t, direction_t, l3_proto_t >	key_t
	The key for a NAT Binding. More...

Public Member Functions
	nat_binding (const interface &itf, const direction_t &dir, const l3_proto_t &proto, const zone_t &zone)
	Construct a new object matching the desried state. More...
	nat_binding (const nat_binding &o)
	Copy Constructor. More...
	~nat_binding ()
	Destructor. More...
bool	operator== (const nat_binding &n) const
	Comparison operator - for UT. More...
const key_t	key () const
	Return the binding's key. More...
std::shared_ptr< nat_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...

Static Public Member Functions
static std::shared_ptr< nat_binding >	find (const key_t &key)
	Static function to find the bridge_domain in the model. More...
static void	dump (std::ostream &os)
	Dump all nat_bindings into the stream provided. More...

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

Definition at line 30 of file nat_binding.hpp.

Member Typedef Documentation

typedef std::tuple<interface::key_t, direction_t, l3_proto_t> VOM::nat_binding::key_t

The key for a NAT Binding.

The zoe is not included, since the same interface is never inside and outside.

Definition at line 66 of file nat_binding.hpp.

Constructor & Destructor Documentation

VOM::nat_binding::nat_binding	(	const interface &	itf,
		const direction_t &	dir,
		const l3_proto_t &	proto,
		const zone_t &	zone
	)

Construct a new object matching the desried state.

Parameters

itf	The interface onto which we bind/apply the feature
dir	The direction (input/output)
proto	The L3 proto used inside.
zone	The NAT zone for the link

Definition at line 43 of file nat_binding.cpp.

VOM::nat_binding::nat_binding

(

const nat_binding &

o

)

Copy Constructor.

Definition at line 55 of file nat_binding.cpp.

VOM::nat_binding::~nat_binding

(

)

Destructor.

Definition at line 64 of file nat_binding.cpp.

Here is the call graph for this function:

Member Function Documentation

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

static

Dump all nat_bindings into the stream provided.

Definition at line 158 of file nat_binding.cpp.

std::shared_ptr< nat_binding > VOM::nat_binding::find ( const key_t &  key )

static

Static function to find the bridge_domain in the model.

Definition at line 146 of file nat_binding.cpp.

const nat_binding::key_t VOM::nat_binding::key

(

)

const

Return the binding's key.

Definition at line 71 of file nat_binding.cpp.

Here is the caller graph for this function:

bool VOM::nat_binding::operator==

(

const nat_binding &

n

)

const

Comparison operator - for UT.

Definition at line 77 of file nat_binding.cpp.

Here is the call graph for this function:

std::shared_ptr< nat_binding > VOM::nat_binding::singular

(

)

const

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

Definition at line 152 of file nat_binding.cpp.

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

virtual

convert to string format for debug purposes

Implements VOM::object_base.

Definition at line 129 of file nat_binding.cpp.

Here is the call graph for this function:

Friends And Related Function Documentation

friend class OM

friend

Definition at line 170 of file nat_binding.hpp.

friend class singular_db< const key_t, nat_binding >

friend

It's the singular_db class that calls replay()

Definition at line 175 of file nat_binding.hpp.

---

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

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