Event Struct Reference

#include <evo/event.h>

Inheritance diagram for Event:

Detailed Description

Event base type used with EventQueue.

• An event is instantiated with C++ "new" operator, then is added to an EventQueue or EventThreadPool for processing (which takes ownership of the pointer)
  • See EventQueue::add() or EventThreadPool::add()
• The event processor calls operator()() to invoke the event, which returns whether the event is finished, and if true the processor frees the event object

Public Member Functions
	Event ()
	Constructor. More...
virtual	~Event ()
	Destructor. More...
virtual bool	operator() ()=0
	Event function. More...

Constructor & Destructor Documentation

Event()

Event ( )

inline

Constructor.

~Event()

virtual ~Event ( )

inlinevirtual

Destructor.

Member Function Documentation

operator()()

virtual bool operator() ( )

pure virtual

Event function.

• This is called by EventQueue to process the event
• The return value identifies whether the caller should free this object
• Caution: This must not throw any exception

Returns

Whether event is finished and ready to be freed, false if ownership was transferred elsewhere

Implemented in EventLambda.

---

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

• evo/event.h