knode
#include <scheduler.h>

Signals | |
| void | netActive (bool) | 
Public Member Functions | |
| Scheduler (QObject *parent=0) | |
| ~Scheduler () | |
| void | addJob (KNJobData *job) | 
| void | cancelJobs (int type=0, KPIM::ProgressItem *item=0) | 
| QMutex & | nntpMutex () | 
Protected Attributes | |
| KNJobData * | currentNntpJob | 
| KNJobData * | currentSmtpJob | 
| QMutex | nntp_Mutex | 
Detailed Description
The job scheduler.
This class manages three diffrent queues of all created jobs:
- a queue for all NNTP jobs
 - a queue for all SMTP jobs
 - a queue for jobs that are waiting for KWallet At most two jobs (one NNTP, one SMTP job) are executed at once.
 
- Todo:
 - Add per-account queues and execute one job per account.
 
- See also
 - KNGlobals::scheduler()
 
Definition at line 41 of file scheduler.h.
Constructor & Destructor Documentation
      
  | 
  explicit | 
Create a new Scheduler object.
- Parameters
 - 
  
parent The parent QObject.  
Definition at line 32 of file scheduler.cpp.
| Scheduler::~Scheduler | ( | ) | 
Definition at line 41 of file scheduler.cpp.
Member Function Documentation
| void Scheduler::addJob | ( | KNJobData * | job | ) | 
Adds a new job to the scheduler queue.
- Parameters
 - 
  
job The new job.  
Definition at line 46 of file scheduler.cpp.
| void Scheduler::cancelJobs | ( | int | type = 0,  | 
        
| KPIM::ProgressItem * | item = 0  | 
        ||
| ) | 
Cancel the selected jobs.
- Parameters
 - 
  
type Cancel all jobs of the given type, 0 means all. item Cancel the job associated with this progress item. If item is 0, only the job type is evaluated.  
Definition at line 126 of file scheduler.cpp.
      
  | 
  signal | 
Indicates whether there are currently active jobs, useful to e.g.
enable a cancel button.
      
  | 
  inline | 
Definition at line 58 of file scheduler.h.
Member Data Documentation
      
  | 
  protected | 
the currently active NNTP job
Definition at line 69 of file scheduler.h.
      
  | 
  protected | 
the currently active SMTP job
Definition at line 71 of file scheduler.h.
      
  | 
  protected | 
Definition at line 72 of file scheduler.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:58:37 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.
    KDE API Reference