kmail Library API Documentation

jobscheduler.h

00001 
00029 #ifndef KMAIL_JOBSCHEDULER_H
00030 #define KMAIL_JOBSCHEDULER_H
00031 
00032 #include <qobject.h>
00033 #include <qvaluelist.h>
00034 #include <qguardedptr.h>
00035 #include <qtimer.h>
00036 
00037 #include "folderjob.h"
00038 
00039 // If this define is set, JobScheduler will show debug output, and related kmkernel timers will be shortened
00040 // This is for debugging purposes only, don't commit with it.
00041 //#define DEBUG_SCHEDULER
00042 
00043 class KMFolder;
00044 namespace KMail {
00045 
00046 class FolderJob;
00047 class ScheduledJob;
00048 
00054 class ScheduledTask {
00055 public:
00059   ScheduledTask( KMFolder* folder, bool immediate )
00060     : mCurrentFolder( folder ), mImmediate( immediate ) {}
00061   virtual ~ScheduledTask() {}
00062 
00070   virtual ScheduledJob* run() = 0;
00071 
00076   virtual int taskTypeId() const = 0;
00077 
00079   KMFolder* folder() const { return mCurrentFolder; }
00080 
00081   bool isImmediate() const { return mImmediate; }
00082 
00083 private:
00084   QGuardedPtr<KMFolder> mCurrentFolder;
00085   bool mImmediate;
00086 };
00087 
00096 class JobScheduler : public QObject
00097 {
00098   Q_OBJECT
00099 public:
00100   JobScheduler( QObject* parent, const char* name = 0 );
00101   ~JobScheduler();
00102 
00105   void registerTask( ScheduledTask* task );
00106 
00109   void notifyOpeningFolder( KMFolder* folder );
00110 
00111 private slots:
00113   void slotRunNextJob();
00114 
00116   void slotJobFinished();
00117 
00118 private:
00119   void restartTimer();
00120   void interruptCurrentTask();
00121   void runTaskNow( ScheduledTask* task );
00122   typedef QValueList<ScheduledTask *> TaskList;
00123   void removeTask( TaskList::Iterator& it );
00124 private:
00125   TaskList mTaskList; // FIFO of tasks to be run
00126 
00127   QTimer mTimer;
00128   int mPendingImmediateTasks;
00129 
00131   ScheduledTask* mCurrentTask;
00132   ScheduledJob* mCurrentJob;
00133 };
00134 
00138 class ScheduledJob : public FolderJob
00139 {
00140 public:
00141   ScheduledJob( KMFolder* folder, bool immediate );
00142 
00143   bool isOpeningFolder() const { return mOpeningFolder; }
00144 
00145 protected:
00146   bool mImmediate;
00147   bool mOpeningFolder;
00148 };
00149 
00150 } // namespace
00151 
00152 #endif /* KMAIL_JOBSCHEDULER_H */
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 22:43:42 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003