FARGOS/VISTA Object Management Environment Core  ..
FARGOS/VISTA Object Management Environment Core Table of Contents
OMEevent Class Reference

Base class for events within the FARGOS/VISTA Object Management Environment. More...

#include <OMEevent.h>

+ Inheritance diagram for OMEevent:

Public Types

enum  OMEeventType { timerExpired, ioPossible, childDeath, win32Event }
 

Public Member Functions

 OMEevent (OMEeventType t, uint32_t h, OMEeventCallbackFP func, OMEthread *thread=nullptr, void *extra=nullptr)
 
virtual ~OMEevent ()
 
bool operator== (const OMEevent &arg) const
 Event equality. More...
 
bool operator!= (const OMEevent &arg) const
 Event inequality. More...
 
bool operator< (const OMEevent &arg) const
 Event ordering. More...
 
bool postEvent ()
 Post event and call callback function. More...
 
bool isPosted () const
 Check if event has been posted. More...
 

Public Attributes

uint64_t eventHandle
 Event-specific handle. More...
 
OMEeventCallbackFP callback
 Function to service event. More...
 
OMEthreadwaitingThread
 OMEthread to signal. More...
 
void * extraData
 Any event-specific data. More...
 
OMEeventType eventType
 Fundamental event type. More...
 

Private Attributes

bool posted
 

Detailed Description

Base class for events within the FARGOS/VISTA Object Management Environment.

Member Enumeration Documentation

◆ OMEeventType

Enumerator
timerExpired 

elapsed time timer

ioPossible 

data available/can be written

childDeath 

child process terminated

win32Event 

Microsoft Windows-specific event.

Constructor & Destructor Documentation

◆ OMEevent()

OMEevent::OMEevent ( OMEeventType  t,
uint32_t  h,
OMEeventCallbackFP  func,
OMEthread thread = nullptr,
void *  extra = nullptr 
)
inline

◆ ~OMEevent()

virtual OMEevent::~OMEevent ( )
inlinevirtual

Member Function Documentation

◆ isPosted()

bool OMEevent::isPosted ( ) const
inline

Check if event has been posted.

Return values
0Event has not yet been posted.
1Event has been posted.

References posted.

◆ operator!=()

bool OMEevent::operator!= ( const OMEevent arg) const
inline

Event inequality.

References eventHandle, and eventType.

◆ operator<()

bool OMEevent::operator< ( const OMEevent arg) const
inline

Event ordering.

References eventHandle, and eventType.

◆ operator==()

bool OMEevent::operator== ( const OMEevent arg) const
inline

Event equality.

References eventHandle, and eventType.

◆ postEvent()

bool OMEevent::postEvent ( )
inline

Post event and call callback function.

Return values
0Event was handled and event should now be deleted.
1Event record should not be deleted.

References posted, and waitingThread.

Member Data Documentation

◆ callback

OMEeventCallbackFP OMEevent::callback

Function to service event.

Referenced by OMEevent().

◆ eventHandle

uint64_t OMEevent::eventHandle

Event-specific handle.

Referenced by OMEioEvent::deselectIOevent(), OMEevent(), operator!=(), operator<(), and operator==().

◆ eventType

OMEeventType OMEevent::eventType

Fundamental event type.

Referenced by OMEaddEventToQueue(), OMEevent(), operator!=(), operator<(), and operator==().

◆ extraData

void* OMEevent::extraData

Any event-specific data.

Referenced by OMEevent().

◆ posted

bool OMEevent::posted
private

Referenced by isPosted(), OMEevent(), and postEvent().

◆ waitingThread

OMEthread* OMEevent::waitingThread

OMEthread to signal.

Referenced by OMEevent(), and postEvent().


The documentation for this class was generated from the following file:
Generated: Fri Jul 31 2020 18:19:16
Support Information