VOM::interface_span_cmds::config_cmd Class Reference

A command class that configures the interface span. More...

Inheritance diagram for VOM::interface_span_cmds::config_cmd:

Collaboration diagram for VOM::interface_span_cmds::config_cmd:

Public Member Functions
	config_cmd (HW::item< bool > &item, const handle_t &itf_from, const handle_t &itf_to, const interface_span::state_t &state)
	Constructor. More...
rc_t	issue (connection &con)
	Issue the command to VPP/HW. More...
std::string	to_string () const
	convert to string format for debug purposes More...
bool	operator== (const config_cmd &i) const
	Comparison operator - only used for UT. More...
Public Member Functions inherited from VOM::rpc_cmd< HW::item< bool >, vapi::Sw_interface_span_enable_disable >
	rpc_cmd (HW::item< bool > &item)
	Constructor taking the HW item that will be updated by the command. More...
virtual	~rpc_cmd ()
	Desructor. More...
HW::item< bool > &	item ()
	return the HW item the command updates More...
const HW::item< bool > &	item () const
	return the const HW item the command updates More...
void	fulfill (const HW::item< bool > &d)
	Fulfill the commands promise. More...
rc_t	wait ()
	Wait on the commands promise. More...
virtual void	succeeded ()
	Called by the HW Command Q when it is disabled to indicate the command can be considered successful without issuing it to HW. More...
virtual vapi_error_e	operator() (vapi::Sw_interface_span_enable_disable &reply)
	call operator used as a callback by VAPI when the reply is available More...
virtual void	retire (connection &con)
	Retire/cancel a long running command. More...
Public Member Functions inherited from VOM::cmd
	cmd ()
	Default constructor. More...
virtual	~cmd ()
	Virtual destructor. More...

Additional Inherited Members
Public Types inherited from VOM::rpc_cmd< HW::item< bool >, vapi::Sw_interface_span_enable_disable >
typedef vapi::Sw_interface_span_enable_disable	msg_t
	convenient typedef More...
Protected Attributes inherited from VOM::rpc_cmd< HW::item< bool >, vapi::Sw_interface_span_enable_disable >
HW::item< bool > &	m_hw_item
	A reference to an object's HW::item that the command will update. More...
std::promise< HW::item< bool > >	m_promise
	The promise that implements the synchronous issue. More...

Detailed Description

A command class that configures the interface span.

Definition at line 31 of file interface_span_cmds.hpp.

Constructor & Destructor Documentation

config_cmd()

VOM::interface_span_cmds::config_cmd::config_cmd	(	HW::item< bool > &	item,
		const handle_t &	itf_from,
		const handle_t &	itf_to,
		const interface_span::state_t &	state
	)

Constructor.

Definition at line 23 of file interface_span_cmds.cpp.

Member Function Documentation

issue()

rc_t VOM::interface_span_cmds::config_cmd::issue ( connection &  con )

virtual

Issue the command to VPP/HW.

Implements VOM::cmd.

Definition at line 41 of file interface_span_cmds.cpp.

Here is the call graph for this function:

operator==()

bool VOM::interface_span_cmds::config_cmd::operator==

(

const config_cmd &

i

)

const

Comparison operator - only used for UT.

Definition at line 34 of file interface_span_cmds.cpp.

to_string()

std::string VOM::interface_span_cmds::config_cmd::to_string ( void  ) const

virtual

convert to string format for debug purposes

Implements VOM::cmd.

Definition at line 57 of file interface_span_cmds.cpp.

Here is the call graph for this function:

---

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

• extras/vom/vom/interface_span_cmds.hpp
• extras/vom/vom/interface_span_cmds.cpp