Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / kmail

kmail jobscheduler.cpp Go to the documentation of this file. #include "jobscheduler.h" #include "kmfolder.h" #include "folderstorage.h" #include "kmfoldermgr.h" #include <kdebug.h> using namespace KMail; JobScheduler::JobScheduler( QObject* parent, const char* name ) : QObject( parent, name ), mTimer( this, "mTimer" ), mPendingImmediateTasks( 0 ), mCurrentTask( 0 ), mCurrentJob( 0 ) { connect( &mTimer, SIGNAL( timeout() ), SLOT( slotRunNextJob() ) ); // No need to start the internal timer yet, we wait for a task to be scheduled } JobScheduler::~JobScheduler() { // delete tasks in tasklist (no autodelete for QValueList) for( TaskList::Iterator it = mTaskList.begin(); it != mTaskList.end(); ++it ) { delete (*it); } delete mCurrentTask; delete mCurrentJob; } void JobScheduler::registerTask( ScheduledTask* task ) { bool immediate = task->isImmediate(); int typeId = task->taskTypeId(); if ( typeId ) { KMFolder* folder = task->folder(); // Search for an identical task already scheduled for( TaskList::Iterator it = mTaskList.begin(); it != mTaskList.end(); ++it ) { if ( (*it)->taskTypeId() == typeId && (*it)->folder() == folder ) { #ifdef DEBUG_SCHEDULER kdDebug(5006) << "JobScheduler: already having task type " << typeId << " for folder " << folder->label() << endl; #endif delete task; if ( !mCurrentTask && immediate ) { ScheduledTask* task = *it; removeTask( it ); runTaskNow( task ); } return; } } // Note that scheduling an identical task as the one currently running is allowed. } if ( !mCurrentTask && immediate ) runTaskNow( task ); else { #ifdef DEBUG_SCHEDULER kdDebug(5006) << "JobScheduler: adding task " << task << " (type " << task->taskTypeId() << ") for folder " << task->folder() << " " << task->folder()->label() << endl; #endif mTaskList.append( task ); if ( immediate ) ++mPendingImmediateTasks; if ( !mCurrentTask && !mTimer.isActive() ) restartTimer(); } } void JobScheduler::removeTask( TaskList::Iterator& it ) { if ( (*it)->isImmediate() ) --mPendingImmediateTasks; mTaskList.remove( it ); } void JobScheduler::notifyOpeningFolder( KMFolder* folder ) { if ( mCurrentTask && mCurrentTask->folder() == folder ) { if ( mCurrentJob->isOpeningFolder() ) { // set when starting a job for this folder #ifdef DEBUG_SCHEDULER kdDebug(5006) << "JobScheduler: got the opening-notification for " << folder->label() << " as expected." << endl; #endif } else { // Jobs scheduled from here should always be cancellable. // One exception though, is when ExpireJob does its final KMMoveCommand. // Then that command shouldn't kill its own parent job just because it opens a folder... if ( mCurrentJob->isCancellable() ) interruptCurrentTask(); } } } void JobScheduler::interruptCurrentTask() { Q_ASSERT( mCurrentTask ); #ifdef DEBUG_SCHEDULER kdDebug(5006) << "JobScheduler: interrupting job " << mCurrentJob << " for folder " << mCurrentTask->folder()->label() << endl; #endif // File it again. This will either delete it or put it in mTaskList. registerTask( mCurrentTask ); mCurrentTask = 0; mCurrentJob->kill(); // This deletes the job and calls slotJobFinished! } void JobScheduler::slotRunNextJob() { while ( !mCurrentJob ) { #ifdef DEBUG_SCHEDULER kdDebug(5006) << "JobScheduler: slotRunNextJob" << endl; #endif Q_ASSERT( mCurrentTask == 0 ); ScheduledTask* task = 0; // Find a task suitable for being run for( TaskList::Iterator it = mTaskList.begin(); it != mTaskList.end(); ++it ) { // Remove if folder died KMFolder* folder = (*it)->folder(); if ( folder == 0 ) { #ifdef DEBUG_SCHEDULER kdDebug(5006) << " folder for task " << (*it) << " was deleted" << endl; #endif removeTask( it ); if ( !mTaskList.isEmpty() ) slotRunNextJob(); // to avoid the mess with invalid iterators :) else mTimer.stop(); return; } // The condition is that the folder must be unused (not open) // But first we ask search folders to release their access to it kmkernel->searchFolderMgr()->tryReleasingFolder( folder ); #ifdef DEBUG_SCHEDULER kdDebug(5006) << " looking at folder " << folder->label() << " " << folder->location() << " isOpened=" << (*it)->folder()->isOpened() << endl; #endif if ( !folder->isOpened() ) { task = *it; removeTask( it ); break; } } if ( !task ) // found nothing to run, i.e. folder was opened return; // Timer keeps running, i.e. try again in 1 minute runTaskNow( task ); } // If nothing to do for that task, loop and find another one to run } void JobScheduler::restartTimer() { if ( mPendingImmediateTasks > 0 ) slotRunNextJob(); else { #ifdef DEBUG_SCHEDULER mTimer.start( 10000 ); // 10 seconds #else mTimer.start( 1 * 60000 ); // 1 minute #endif } } void JobScheduler::runTaskNow( ScheduledTask* task ) { Q_ASSERT( mCurrentTask == 0 ); if ( mCurrentTask ) { interruptCurrentTask(); } mCurrentTask = task; mTimer.stop(); mCurrentJob = mCurrentTask->run(); #ifdef DEBUG_SCHEDULER kdDebug(5006) << "JobScheduler: task " << mCurrentTask << " (type " << mCurrentTask->taskTypeId() << ")" << " for folder " << mCurrentTask->folder()->label() << " returned job " << mCurrentJob << " " << ( mCurrentJob?mCurrentJob->className():0 ) << endl; #endif if ( !mCurrentJob ) { // nothing to do, e.g. folder deleted delete mCurrentTask; mCurrentTask = 0; if ( !mTaskList.isEmpty() ) restartTimer(); return; } // Register the job in the folder. This makes it autodeleted if the folder is deleted. mCurrentTask->folder()->storage()->addJob( mCurrentJob ); connect( mCurrentJob, SIGNAL( finished() ), this, SLOT( slotJobFinished() ) ); mCurrentJob->start(); } void JobScheduler::slotJobFinished() { // Do we need to test for mCurrentJob->error()? What do we do then? #ifdef DEBUG_SCHEDULER kdDebug(5006) << "JobScheduler: slotJobFinished" << endl; #endif delete mCurrentTask; mCurrentTask = 0; mCurrentJob = 0; if ( !mTaskList.isEmpty() ) restartTimer(); } // DCOP call to pause any background jobs void JobScheduler::pause() { mPendingImmediateTasks = 0; if ( mCurrentJob && mCurrentJob->isCancellable() ) interruptCurrentTask(); mTimer.stop(); } void JobScheduler::resume() { restartTimer(); } KMail::ScheduledJob::ScheduledJob( KMFolder* folder, bool immediate ) : FolderJob( 0, tOther, folder ), mImmediate( immediate ), mOpeningFolder( false ) { mCancellable = true; mSrcFolder = folder; } #include "jobscheduler.moc" kmail Skip menu "kmail" Main Page Namespace List Class Hierarchy Alphabetical List Class List File List Namespace Members Class Members Related Pages API Reference Skip menu "API Reference"   doc kioslaves kmail konsolekalendar kpilot libemailfunctions libkcal Generated for API Reference by doxygen 1.5.9 This website is maintained by Adriaan de Groot and Allen Winter. KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal