A command poll the HW for liveness. More...

Inheritance diagram for VOM::hw_cmds::poll:

Collaboration diagram for VOM::hw_cmds::poll:

Public Member Functions
	poll (HW::item< bool > &item)
	Constructor taking the HW::item to update. 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 poll &i) const
	Comparison operator - only used for UT. More...

Public Member Functions inherited from VOM::rpc_cmd< HW::item< bool >, rc_t, vapi::Control_ping >
	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 rc_t &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::Control_ping &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 >, rc_t, vapi::Control_ping >
typedef vapi::Control_ping	msg_t
	convenient typedef More...

Protected Attributes inherited from VOM::rpc_cmd< HW::item< bool >, rc_t, vapi::Control_ping >
HW::item< bool > &	m_hw_item
	A reference to an object's HW::item that the command will update. More...

std::promise< rc_t >	m_promise
	The promise that implements the synchronous issue. More...

Detailed Description

A command poll the HW for liveness.

Definition at line 30 of file hw_cmds.hpp.

Constructor & Destructor Documentation

VOM::hw_cmds::poll::poll ( HW::item< bool > & item )

Constructor taking the HW::item to update.

Definition at line 21 of file hw_cmds.cpp.

rc_t VOM::hw_cmds::poll::issue ( connection & con )

virtual

Issue the command to VPP/HW.

Implements VOM::cmd.

Definition at line 27 of file hw_cmds.cpp.

Here is the call graph for this function:

bool VOM::hw_cmds::poll::operator== ( const poll & i ) const

Comparison operator - only used for UT.

std::string VOM::hw_cmds::poll::to_string ( void ) const

virtual

convert to string format for debug purposes

Implements VOM::cmd.

Definition at line 39 of file hw_cmds.cpp.

Here is the call graph for this function:

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