#include <CIdleTask.h>

Inheritance diagram for CIdleTask:

Public Member Functions
	CIdleTask (IPMUnknown *boss)

virtual void	InstallTask (uint32 millisecsBeforeFirstRun)

virtual void	UninstallTask ()

virtual const char *	TaskName ()

Public Member Functions inherited from IIdleTask
virtual uint32	RunTask (uint32 appFlags, IdleTimer *timeCheck)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Additional Inherited Members
Public Types inherited from IIdleTask
enum	{ kDefaultIID = IID_IIDLETASK }

enum	{ kEndOfTime = ~(uint32)0, kOnFlagChange = ~(uint32)1, kNextEventCycle = ~(uint32)2 }

enum	{ kMaxTaskNameLength = 1023 }

Detailed Description

Base implementation of an idle task

Don't return kEndOfTime from RunTask, instead you would call UninstallTask and return any value from RunTask as it will be ignored.

Member Function Documentation

virtual void CIdleTask::InstallTask ( uint32 millisecsBeforeFirstRun )

virtual

If you override InstallTask, call this version in your override. Otherwise, there is no reason to derive from this class.

Implements IIdleTask.

virtual const char* CIdleTask::TaskName ( )

virtual

Get the task name

Implements IIdleTask.

virtual void CIdleTask::UninstallTask ( )

virtual

If you override UninstallTask, call this version in your override Otherwise, there is no reason to derive from this class

Implements IIdleTask.