kmail

KMail::JobScheduler Class Reference

The unique JobScheduler instance (owned by kmkernel) implements "background processing" of folder operations (like expiration and compaction). More...

#include <jobscheduler.h>

Inheritance diagram for KMail::JobScheduler:

List of all members.


Public Member Functions

 JobScheduler (QObject *parent, const char *name=0)
void notifyOpeningFolder (KMFolder *folder)
void pause ()
void registerTask (ScheduledTask *task)
void resume ()
 ~JobScheduler ()

Detailed Description

The unique JobScheduler instance (owned by kmkernel) implements "background processing" of folder operations (like expiration and compaction).

Tasks (things to be done) are registered with the JobScheduler, and it will execute them one at a time, separated with a 1-minute timer. The jobs themselves should use timers to avoid using too much CPU for too long. Tasks for opened folders are not executed until the folder is closed.

Definition at line 96 of file jobscheduler.h.


Constructor & Destructor Documentation

JobScheduler::JobScheduler ( QObject parent,
const char *  name = 0 
)

Definition at line 37 of file jobscheduler.cpp.

JobScheduler::~JobScheduler (  ) 

Definition at line 47 of file jobscheduler.cpp.


Member Function Documentation

void JobScheduler::notifyOpeningFolder ( KMFolder folder  ) 

Called by [implementations of] FolderStorage::open() Interrupt any running job for this folder and re-schedule it for later.

Definition at line 102 of file jobscheduler.cpp.

void JobScheduler::pause (  ) 

Definition at line 233 of file jobscheduler.cpp.

void JobScheduler::registerTask ( ScheduledTask task  ) 

Register a task to be done for a given folder The ownership of the task is transferred to the JobScheduler.

Definition at line 57 of file jobscheduler.cpp.

void JobScheduler::resume (  ) 

Definition at line 241 of file jobscheduler.cpp.


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