VICI  0.11.815
Visual Chart Interpreter
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
VICI::cdi::TestEventQueue Class Reference

Responsible for queuing TestEvents. More...

#include <vici/testmgr.h>

Public Member Functions

 ~TestEventQueue ()
 Destructor.
 
void enqueueEvent (TestEvent *)
 Place the event on the queue. More...
 

Static Public Member Functions

static TestEventQueueinstance ()
 Get reference to the singleton queue object. More...
 
static void event (csr id)
 Create a TestEvent, queue it, and wait for it to be processed. More...
 

Public Attributes

std::mutex eventMx
 Control access to the queue.
 
std::list< TestEvent * > events
 The queue.
 
std::set< std::string > runningEvents
 The set of events being handled.
 
std::mutex functionsMx
 Control access to list of running events.
 
std::condition_variable eventCV
 Wait for event to be queued or processed.
 

Protected Member Functions

 TestEventQueue ()
 Constructor.
 

Detailed Description

Responsible for queuing TestEvents.

The queue provides a condition variable that allows the test case to wait until an event has been queued.

Member Function Documentation

void TestEventQueue::enqueueEvent ( TestEvent ev)

Place the event on the queue.

Parameters
evThe TestEvent object to place on the queue
void TestEventQueue::event ( csr  id)
static

Create a TestEvent, queue it, and wait for it to be processed.

Parameters
idThe identity for the event
TestEventQueue & TestEventQueue::instance ( )
static

Get reference to the singleton queue object.

Returns
reference to the TestEventQueue

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