A cmd class that Dumps all the GBP contracts. More...

Inheritance diagram for VOM::gbp_contract_cmds::dump_cmd:

Collaboration diagram for VOM::gbp_contract_cmds::dump_cmd:

Public Member Functions
	dump_cmd ()=default
	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 dump_cmd &i) const
	Comparison operator - only used for UT. More...

Public Member Functions inherited from VOM::dump_cmd< vapi::Gbp_contract_dump >
	dump_cmd ()
	Default Constructor. More...

	dump_cmd (const dump_cmd &d)=default

virtual	~dump_cmd ()
	Destructor. More...

const_iterator	begin ()
	Constant iterator to the start of the records retunred during the dump. More...

const_iterator	end ()
	Constant iterator to the end of the records retunred during the dump. More...

rc_t	wait ()
	Wait for the issue of the command to complete. More...

vapi_error_e	operator() (vapi::Gbp_contract_dump &d)
	Call operator called when the dump is complete. 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::dump_cmd< vapi::Gbp_contract_dump >
typedef vapi::Gbp_contract_dump	msg_t

typedef vapi::Gbp_contract_dump ::resp_type	record_t

typedef vapi::Result_set< typename vapi::Gbp_contract_dump ::resp_type >::const_iterator	const_iterator

Protected Member Functions inherited from VOM::dump_cmd< vapi::Gbp_contract_dump >
void	succeeded ()
	Dump commands should not be issued whilst the HW is disabled. More...

Protected Attributes inherited from VOM::dump_cmd< vapi::Gbp_contract_dump >
std::promise< rc_t >	m_promise
	The underlying promise that implements the synchornous nature of the command issue. More...

std::unique_ptr< vapi::Gbp_contract_dump >	m_dump
	The VAPI event registration. More...

Detailed Description

A cmd class that Dumps all the GBP contracts.

Definition at line 108 of file gbp_contract_cmds.hpp.

Constructor & Destructor Documentation

VOM::gbp_contract_cmds::dump_cmd::dump_cmd ( )

default

Constructor.

rc_t VOM::gbp_contract_cmds::dump_cmd::issue ( connection & con )

virtual

Issue the command to VPP/HW.

Implements VOM::cmd.

Definition at line 174 of file gbp_contract_cmds.cpp.

Here is the call graph for this function:

bool VOM::gbp_contract_cmds::dump_cmd::operator== ( const dump_cmd & i ) const

Comparison operator - only used for UT.

Definition at line 168 of file gbp_contract_cmds.cpp.

std::string VOM::gbp_contract_cmds::dump_cmd::to_string ( void ) const

virtual

convert to string format for debug purposes

Implements VOM::cmd.

Definition at line 186 of file gbp_contract_cmds.cpp.

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