KDE PIM / Developers / API Docs / 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>

Inherits QObject.

List of all members.

Public Member Functions


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.


Member Function Documentation

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.

void JobScheduler::notifyOpeningFolder KMFolder folder  ) 
 

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


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