VOM::HW::cmd_q Class Reference

The pipe to VPP into which we write the commands. More...

Public Member Functions
	cmd_q ()
	Constructor. More...
	~cmd_q ()
	Destructor. More...
cmd_q &	operator= (const cmd_q &f)
	Copy assignement - only used in UT. More...
virtual void	enqueue (cmd *c)
	Enqueue a command into the Q. More...
virtual void	enqueue (std::shared_ptr< cmd > c)
	Enqueue a command into the Q. More...
virtual void	enqueue (std::queue< cmd * > &c)
	Enqueue a set of commands. More...
virtual rc_t	write ()
	Write all the commands to HW. More...
virtual void	connect ()
	Blocking Connect to VPP - call once at bootup. More...
void	disable ()
	Disable the passing of commands to VPP. More...
void	enable ()
	Enable the passing of commands to VPP - undoes the disable. More...

Detailed Description

The pipe to VPP into which we write the commands.

Definition at line 186 of file hw.hpp.

Constructor & Destructor Documentation

VOM::HW::cmd_q::cmd_q

(

)

Constructor.

Definition at line 21 of file hw.cpp.

Here is the caller graph for this function:

VOM::HW::cmd_q::~cmd_q

(

)

Destructor.

Definition at line 28 of file hw.cpp.

Member Function Documentation

void VOM::HW::cmd_q::connect ( )

virtual

Blocking Connect to VPP - call once at bootup.

Definition at line 80 of file hw.cpp.

Here is the call graph for this function:

void VOM::HW::cmd_q::disable

(

)

Disable the passing of commands to VPP.

Whilst disabled all writes will be discarded. Use this during the reset phase.

Definition at line 105 of file hw.cpp.

void VOM::HW::cmd_q::enable

(

)

Enable the passing of commands to VPP - undoes the disable.

The Q is enabled by default.

Definition at line 99 of file hw.cpp.

void VOM::HW::cmd_q::enqueue ( cmd *  c )

virtual

Enqueue a command into the Q.

Definition at line 55 of file hw.cpp.

void VOM::HW::cmd_q::enqueue ( std::shared_ptr< cmd >  c )

virtual

Enqueue a command into the Q.

Definition at line 63 of file hw.cpp.

void VOM::HW::cmd_q::enqueue ( std::queue< cmd * > &  c )

virtual

Enqueue a set of commands.

Definition at line 69 of file hw.cpp.

HW::cmd_q & VOM::HW::cmd_q::operator=

(

const cmd_q &

f

)

Copy assignement - only used in UT.

Definition at line 38 of file hw.cpp.

Here is the call graph for this function:

rc_t VOM::HW::cmd_q::write ( )

virtual

Write all the commands to HW.

Definition at line 111 of file hw.cpp.

---

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

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