IdleTask_t Class Reference
Base class for background tasks which should be done when the application is idle. More...
#include <UTIdleTask.h>
Public Member Functions | |
| IdleTask_t (int32 poll_interval_seconds) | |
| void | SetPollInterval (int32 poll_interval_seconds) |
| virtual void | PerformIdleWork ()=0 |
Detailed Description
Base class for background tasks which should be done when the application is idle. Such tasks should be added to the global idle message loop, g_idle_message_loop. They can be added using g_idle_message_loop.AddIdleTask, and must be removed from the idle message loop before main returns. Consequently, no global object can rely on its destructor to remove an idle task.
Definition at line 38 of file UTIdleTask.h.
Constructor & Destructor Documentation
| IdleTask_t::IdleTask_t | ( | int32 | poll_interval_seconds | ) | [inline] |
Constructor. The poll interval in seconds cannot exceed 0x7ffffffe / 2000, or 1073741 seconds (12.42 days), nor can it be less than two.
Definition at line 193 of file UTIdleTask.h.
Member Function Documentation
| void IdleTask_t::SetPollInterval | ( | int32 | poll_interval_seconds | ) | [inline] |
Sets the poll interval. The poll interval in seconds cannot exceed 0x7ffffffe / 2000, or 1073741 seconds (12.42 days), nor can it be less than two.
Definition at line 201 of file UTIdleTask.h.
| virtual void IdleTask_t::PerformIdleWork | ( | ) | [pure virtual] |
Called when the idle task should do its idle work.
The documentation for this class was generated from the following file:
- D:/develop/svn/utlib/utlib/trunk/UT/src_UT/UTIdleTask.h
