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 private: 00123 typedef QValueList<ScheduledTask *> TaskList; 00124 TaskList mTaskList; // FIFO of tasks to be run 00125 00126 QTimer mTimer; 00127 int mPendingImmediateTasks; 00128 00130 ScheduledTask* mCurrentTask; 00131 ScheduledJob* mCurrentJob; 00132 }; 00133 00137 class ScheduledJob : public FolderJob 00138 { 00139 public: 00140 ScheduledJob( KMFolder* folder, bool immediate ); 00141 00142 bool isOpeningFolder() const { return mOpeningFolder; } 00143 00144 protected: 00145 bool mImmediate; 00146 bool mOpeningFolder; 00147 }; 00148 00149 } // namespace 00150 00151 #endif /* KMAIL_JOBSCHEDULER_H */
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Aug 27 12:52:17 2004 by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2003