HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HDK_Sample::BackgroundTimer Class Reference

Event generator to poll for completed tasks. More...

+ Inheritance diagram for HDK_Sample::BackgroundTimer:

Public Member Functions

 BackgroundTimer ()
 
virtual ~BackgroundTimer ()
 
virtual const char * getClassName () const
 
virtual int getPollTime ()
 Poll time is in ms, so poll every 0.5 seconds. More...
 
virtual int processEvents ()
 This callback is used to process events. More...
 
- Public Member Functions inherited from FS_EventGenerator
 FS_EventGenerator ()
 
virtual ~FS_EventGenerator ()
 
virtual int getFileDescriptor ()
 
virtual bool areEventsWaiting ()
 
int installGenerator ()
 
void uninstallGenerator ()
 
void pollEventLoop (bool drain_queue=true)
 

Static Public Member Functions

static void stopPolling ()
 Stop polling process. More...
 
static void startPolling ()
 Start polling process. More...
 
- Static Public Member Functions inherited from FS_EventGenerator
static void setInstaller (FS_EventInstaller installer)
 
static void setEventLoopPollCallback (FS_PollCallback callback)
 
static bool isEventLoopPollCallbackSet ()
 

Detailed Description

Event generator to poll for completed tasks.

When Houdini has an opportunity, it will call this class to process any events. Ideally, we would use the FS_EventGenerator::getFileDescriptor() method to return a file descriptor which allows a select() call to be used rather than a polling process. However, in this case, we need to poll the background processes.

Definition at line 151 of file FS_Background.C.

Constructor & Destructor Documentation

HDK_Sample::BackgroundTimer::BackgroundTimer ( )
inline
Examples:
FS/FS_Background.C.

Definition at line 153 of file FS_Background.C.

virtual HDK_Sample::BackgroundTimer::~BackgroundTimer ( )
inlinevirtual
Examples:
FS/FS_Background.C.

Definition at line 154 of file FS_Background.C.

Member Function Documentation

virtual const char* HDK_Sample::BackgroundTimer::getClassName ( ) const
inlinevirtual

Implements FS_EventGenerator.

Examples:
FS/FS_Background.C.

Definition at line 156 of file FS_Background.C.

virtual int HDK_Sample::BackgroundTimer::getPollTime ( )
inlinevirtual

Poll time is in ms, so poll every 0.5 seconds.

Reimplemented from FS_EventGenerator.

Examples:
FS/FS_Background.C.

Definition at line 159 of file FS_Background.C.

virtual int HDK_Sample::BackgroundTimer::processEvents ( )
inlinevirtual

This callback is used to process events.

Implements FS_EventGenerator.

Examples:
FS/FS_Background.C.

Definition at line 162 of file FS_Background.C.

static void HDK_Sample::BackgroundTimer::startPolling ( )
inlinestatic

Start polling process.

Examples:
FS/FS_Background.C.

Definition at line 188 of file FS_Background.C.

static void HDK_Sample::BackgroundTimer::stopPolling ( )
inlinestatic

Stop polling process.

Examples:
FS/FS_Background.C.

Definition at line 173 of file FS_Background.C.


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