Equalizer  1.8.0
Parallel Rendering Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
eq::MessagePump Class Referenceabstract

An interface to process system messages or events. More...

#include <messagePump.h>

+ Inheritance diagram for eq::MessagePump:
+ Collaboration diagram for eq::MessagePump:

Public Member Functions

 MessagePump ()
 Construct a new message pump. More...
 
virtual ~MessagePump ()
 Destruct this message pump. More...
 
virtual void postWakeup ()=0
 Unblock dispatchOne(). More...
 
virtual void dispatchAll ()=0
 Dispatch all pending system events, does not block. More...
 
virtual void dispatchOne (const uint32_t timeout=LB_TIMEOUT_INDEFINITE)=0
 Dispatch at least one pending system event, blocks potentially. More...
 
virtual void register_ (dc::Proxy *)
 Register a new DC connection for event dispatch. More...
 
virtual void deregister (dc::Proxy *)
 Deregister a DC connection from event dispatch. More...
 

Detailed Description

An interface to process system messages or events.

Definition at line 27 of file messagePump.h.

Constructor & Destructor Documentation

eq::MessagePump::MessagePump ( )
inline

Construct a new message pump.

Version
1.0

Definition at line 31 of file messagePump.h.

virtual eq::MessagePump::~MessagePump ( )
inlinevirtual

Destruct this message pump.

Version
1.0

Reimplemented in eq::glx::MessagePump, eq::qt::MessagePump, and eq::wgl::MessagePump.

Definition at line 34 of file messagePump.h.

Member Function Documentation

virtual void eq::MessagePump::deregister ( dc::Proxy *  )
inlinevirtual

Deregister a DC connection from event dispatch.

Version
1.7.1

Reimplemented in eq::glx::MessagePump.

Definition at line 55 of file messagePump.h.

virtual void eq::MessagePump::dispatchAll ( )
pure virtual

Dispatch all pending system events, does not block.

Version
1.0

Implemented in eq::glx::MessagePump, eq::qt::MessagePump, and eq::wgl::MessagePump.

virtual void eq::MessagePump::dispatchOne ( const uint32_t  timeout = LB_TIMEOUT_INDEFINITE)
pure virtual

Dispatch at least one pending system event, blocks potentially.

Parameters
timeoutthe time to wait for an event
Version
1.0

Implemented in eq::glx::MessagePump, eq::qt::MessagePump, and eq::wgl::MessagePump.

virtual void eq::MessagePump::postWakeup ( )
pure virtual
virtual void eq::MessagePump::register_ ( dc::Proxy *  )
inlinevirtual

Register a new DC connection for event dispatch.

Version
1.7.1

Reimplemented in eq::glx::MessagePump.

Definition at line 51 of file messagePump.h.


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