KNode::Scheduler Class Reference

#include <scheduler.h>

Inheritance diagram for KNode::Scheduler:

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 ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Attributes
KNJobData *	currentNntpJob
KNJobData *	currentSmtpJob
QMutex	nntp_Mutex

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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

Scheduler::Scheduler ( QObject *  parent = 0 )

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.

void KNode::Scheduler::netActive ( bool  )

signal

Indicates whether there are currently active jobs, useful to e.g.

enable a cancel button.

QMutex& KNode::Scheduler::nntpMutex ( )

inline

Definition at line 58 of file scheduler.h.

Member Data Documentation

KNJobData* KNode::Scheduler::currentNntpJob

protected

the currently active NNTP job

Definition at line 69 of file scheduler.h.

KNJobData* KNode::Scheduler::currentSmtpJob

protected

the currently active SMTP job

Definition at line 71 of file scheduler.h.

QMutex KNode::Scheduler::nntp_Mutex

protected

Definition at line 72 of file scheduler.h.

---

The documentation for this class was generated from the following files:

• scheduler.h
• scheduler.cpp