jobscheduler.h

/*
 * Copyright (c) 2004 David Faure <faure@kde.org>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *  In addition, as a special exception, the copyright holders give
 *  permission to link the code of this program with any edition of
 *  the TQt library by Trolltech AS, Norway (or with modified versions
 *  of TQt that use the same license as TQt), and distribute linked
 *  combinations including the two.  You must obey the GNU General
 *  Public License in all respects for all of the code used other than
 *  TQt.  If you modify this file, you may extend this exception to
 *  your version of the file, but you are not obligated to do so.  If
 *  you do not wish to do so, delete this exception statement from
 *  your version.
 */
 
#ifndef KMAIL_JOBSCHEDULER_H
#define KMAIL_JOBSCHEDULER_H
 
#include <tqobject.h>
#include <tqvaluelist.h>
#include <tqguardedptr.h>
#include <tqtimer.h>
 
#include "folderjob.h"
 
// If this define is set, JobScheduler will show debug output, and related kmkernel timers will be shortened
// This is for debugging purposes only, don't commit with it.
//#define DEBUG_SCHEDULER
 
class KMFolder;
namespace KMail {
 
class FolderJob;
class ScheduledJob;
 
class ScheduledTask {
public:
  ScheduledTask( KMFolder* folder, bool immediate )
    : mCurrentFolder( folder ), mImmediate( immediate ) {}
  virtual ~ScheduledTask() {}
 
  virtual ScheduledJob* run() = 0;
 
  virtual int taskTypeId() const = 0;
 
  KMFolder* folder() const { return mCurrentFolder; }
 
  bool isImmediate() const { return mImmediate; }
 
private:
  TQGuardedPtr<KMFolder> mCurrentFolder;
  bool mImmediate;
};
 
class JobScheduler : public TQObject
{
  TQ_OBJECT
  
public:
  JobScheduler( TQObject* parent, const char* name = 0 );
  ~JobScheduler();
 
  void registerTask( ScheduledTask* task );
 
  void notifyOpeningFolder( KMFolder* folder );
 
  // DCOP calls
  void pause();
  void resume();
 
private slots:
  void slotRunNextJob();
 
  void slotJobFinished();
 
private:
  void restartTimer();
  void interruptCurrentTask();
  void runTaskNow( ScheduledTask* task );
  typedef TQValueList<ScheduledTask *> TaskList;
  void removeTask( TaskList::Iterator& it );
private:
  TaskList mTaskList; // FIFO of tasks to be run
 
  TQTimer mTimer;
  int mPendingImmediateTasks;
 
  ScheduledTask* mCurrentTask;
  ScheduledJob* mCurrentJob;
};
 
class ScheduledJob : public FolderJob
{
public:
  ScheduledJob( KMFolder* folder, bool immediate );
 
  bool isOpeningFolder() const { return mOpeningFolder; }
 
protected:
  bool mImmediate;
  bool mOpeningFolder;
};
 
} // namespace
 
#endif /* KMAIL_JOBSCHEDULER_H */