VOM::HW Class Reference

Data Structures
class	cmd_q
	The pipe to VPP into which we write the commands. More...
class	item
	A HW::item is data that is either to be written to or read from VPP/HW. More...

Static Public Member Functions
static void	init (cmd_q *f)
	Initialise the HW connection to VPP - the UT version passing a mock Q. More...
static void	init ()
	Initialise the HW. More...
static void	enqueue (cmd *f)
	Enqueue A command for execution. More...
static void	enqueue (std::shared_ptr< cmd > c)
	Enqueue A command for execution. More...
static void	enqueue (std::queue< cmd * > &c)
	Enqueue A set of commands for execution. More...
static rc_t	write ()
	Write/Execute all commands hitherto enqueued. More...
static bool	connect ()
	Blocking Connect to VPP. More...
static void	disconnect ()
	Disconnect to VPP. More...
static bool	poll ()
	Blocking pool of the HW connection. More...

Friends
class	OM
	Only the OM can enable/disable HW. More...

Detailed Description

Definition at line 33 of file hw.hpp.

Member Function Documentation

bool VOM::HW::connect ( )

static

Blocking Connect to VPP.

Definition at line 212 of file hw.cpp.

void VOM::HW::disconnect ( )

static

Disconnect to VPP.

Definition at line 218 of file hw.cpp.

void VOM::HW::enqueue ( cmd *  f )

static

Enqueue A command for execution.

Definition at line 194 of file hw.cpp.

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

static

Enqueue A command for execution.

Definition at line 200 of file hw.cpp.

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

static

Enqueue A set of commands for execution.

Definition at line 206 of file hw.cpp.

void VOM::HW::init ( HW::cmd_q *  f )

static

Initialise the HW connection to VPP - the UT version passing a mock Q.

Initialse the connection to VPP.

Definition at line 179 of file hw.cpp.

void VOM::HW::init ( )

static

Initialise the HW.

Initialse the connection to VPP.

Definition at line 188 of file hw.cpp.

Here is the call graph for this function:

bool VOM::HW::poll ( )

static

Blocking pool of the HW connection.

Definition at line 242 of file hw.cpp.

Here is the call graph for this function:

rc_t VOM::HW::write ( )

static

Write/Execute all commands hitherto enqueued.

Definition at line 236 of file hw.cpp.

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class OM

friend

Only the OM can enable/disable HW.

Definition at line 355 of file hw.hpp.

---

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

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