VOM::srpc_cmd< MSG > Class Template Reference

Inheritance diagram for VOM::srpc_cmd< MSG >:

Collaboration diagram for VOM::srpc_cmd< MSG >:

Public Types
typedef MSG	msg_t
	convenient typedef More...
Public Types inherited from VOM::rpc_cmd< HW::item< handle_t >, MSG >
typedef MSG	msg_t
	convenient typedef More...

Public Member Functions
	srpc_cmd (HW::item< handle_t > &item)
	Constructor taking the HW item that will be updated by the command. More...
virtual	~srpc_cmd ()
	Desructor. More...
virtual vapi_error_e	operator() (MSG &reply)
	call operator used as a callback by VAPI when the reply is available More...
Public Member Functions inherited from VOM::rpc_cmd< HW::item< handle_t >, MSG >
	rpc_cmd (HW::item< handle_t > &item)
	Constructor taking the HW item that will be updated by the command. More...
virtual	~rpc_cmd ()
	Desructor. More...
HW::item< handle_t > &	item ()
	return the HW item the command updates More...
const HW::item< handle_t > &	item () const
	return the const HW item the command updates More...
void	fulfill (const HW::item< handle_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 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...
virtual rc_t	issue (connection &con)=0
	Issue the command to VPP/HW. More...
virtual std::string	to_string () const =0
	convert to string format for debug purposes More...

Additional Inherited Members
Protected Attributes inherited from VOM::rpc_cmd< HW::item< handle_t >, MSG >
HW::item< handle_t > &	m_hw_item
	A reference to an object's HW::item that the command will update. More...
std::promise< HW::item< handle_t > >	m_promise
	The promise that implements the synchronous issue. More...

Detailed Description

template<typename MSG>
class VOM::srpc_cmd< MSG >

Definition at line 24 of file srpc_cmd.hpp.

Member Typedef Documentation

msg_t

template<typename MSG>

typedef MSG VOM::srpc_cmd< MSG >::msg_t

convenient typedef

Definition at line 30 of file srpc_cmd.hpp.

Constructor & Destructor Documentation

srpc_cmd()

template<typename MSG>

VOM::srpc_cmd< MSG >::srpc_cmd ( HW::item< handle_t > &  item )

inline

Constructor taking the HW item that will be updated by the command.

Definition at line 35 of file srpc_cmd.hpp.

~srpc_cmd()

template<typename MSG>

virtual VOM::srpc_cmd< MSG >::~srpc_cmd ( )

inlinevirtual

Desructor.

Definition at line 43 of file srpc_cmd.hpp.

Member Function Documentation

operator()()

template<typename MSG>

virtual vapi_error_e VOM::srpc_cmd< MSG >::operator() ( MSG &  reply )

inlinevirtual

call operator used as a callback by VAPI when the reply is available

Reimplemented from VOM::rpc_cmd< HW::item< handle_t >, MSG >.

Definition at line 45 of file srpc_cmd.hpp.

---

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

• extras/vom/vom/srpc_cmd.hpp