KMail::ScheduledTask Class Reference
A scheduled task is some information about a folder job that should be run later. More...
#include <jobscheduler.h>
Inherited by KMail::ScheduledCompactionTask, and KMail::ScheduledExpireTask.
Public Member Functions
- ScheduledTask (KMFolder *folder, bool immediate)
- virtual ScheduledJob * run ()=0
- virtual int taskTypeId () const =0
- KMFolder * folder () const
- bool isImmediate () const
Detailed Description
A scheduled task is some information about a folder job that should be run later.As long as it's not running, it's called a "task", i.e. something that needs to be done. Tasks are held in the
- See also:
- JobScheduler.
Constructor & Destructor Documentation
|
Create a scheduled task for a given folder If
|
Member Function Documentation
|
Run this task, i.e. create a job for it. Important: the job's execute() method must either call open() on the folder or storage immediately, or abort (deleting itself). Usually, that job should also be cancellable. Otherwise (if the open() is delayed) an unrelated open() could happen first and mess things up. If for some reason (e.g. folder deleted) nothing should be done, return 0. Implemented in KMail::ScheduledCompactionTask, and KMail::ScheduledExpireTask. |
|
An identifier for the type of task (a bit like QListViewItem::rtti) This allows to automatically prevent two identical tasks from being scheduled for the same folder. To circumvent this feature and make every task unique, return 0 here. Implemented in KMail::ScheduledCompactionTask, and KMail::ScheduledExpireTask. |
|
The folder which this task is about, 0 if it was deleted meanwhile.
|
The documentation for this class was generated from the following file:
- jobscheduler.h