• Skip to content
• Skip to link menu

KDE 4.2 API Reference

• KDE API Reference
• kdenetwork

• Sitemap
• Contact Us

 

kget

Job Class Reference

#include <job.h>

Inheritance diagram for Job:

[legend]

List of all members.

---

Detailed Description

Definition at line 32 of file job.h.

Public Types
enum	Policy { Start, Stop, None }
enum	Status {   Running, Delayed, Stopped, Aborted,   Finished }
Public Member Functions
virtual void	delayTimerEvent ()=0
virtual int	elapsedTime () const =0
virtual bool	isResumable () const =0
	Job (JobQueue *parent, Scheduler *scheduler)
JobQueue *	jobQueue ()
Policy	policy () const
virtual void	postDeleteEvent ()
virtual int	remainingTime () const =0
virtual void	setDelay (int seconds)=0
void	setPolicy (Policy jobPolicy)
void	setStatus (Status jobStatus)
virtual void	start ()=0
Status	status () const
virtual void	stop ()=0
virtual	~Job ()
Protected Member Functions
void	postJobEvent (Status)
void	read (QDomNode *n)
Scheduler *	scheduler () const
void	write (QDomNode *n)
Protected Attributes
JobQueue *	m_jobQueue
Scheduler *	m_scheduler

---

Member Enumeration Documentation

enum Job::Policy

The policy property describes how the scheduler should manage this job.

Enumerator:

Start
Stop	The scheduler should start this job even if its queue isn't in a Running status.
None	The scheduler shouldn't never start this job, even if if its queue is in a Running status. The scheduler should start this job depending on its queue status

Definition at line 51 of file job.h.

enum Job::Status

The status property describes the current job status.

Enumerator:

Running
Delayed	The job is being executed.
Stopped	The job is delayed. This means that the scheduler should not start it until it exits from the delayed state
Aborted	The job is stopped.
Finished	The job is stopped, but this also indicates that it stopped because an error occurred. The job exited from its Running state successfully

Definition at line 38 of file job.h.

---

Constructor & Destructor Documentation

Job::Job	(	JobQueue *	parent,
		Scheduler *	scheduler
	)

Definition at line 18 of file job.cpp.

Job::~Job

(

)

[virtual]

Definition at line 27 of file job.cpp.

---

Member Function Documentation

virtual void Job::delayTimerEvent

(

)

[pure virtual]

Implemented in Transfer.

virtual int Job::elapsedTime

(

)

const [pure virtual]

Implemented in Transfer, and BTTransfer.

virtual bool Job::isResumable

(

)

const [pure virtual]

Implemented in BTTransfer, ContentFetch, TransferKio, metalink, MmsTransfer, and transferMultiSegKio.

JobQueue* Job::jobQueue

(

)

[inline]

Definition at line 72 of file job.h.

Policy Job::policy

(

)

const [inline]

Definition at line 79 of file job.h.

virtual void Job::postDeleteEvent

(

)

[inline, virtual]

Reimplemented in BTTransfer, ContentFetch, TransferKio, MmsTransfer, and transferMultiSegKio.

Definition at line 70 of file job.h.

void Job::postJobEvent

(

Status

)

[protected]

This one posts a job event to the scheduler.

void Job::read

(

QDomNode *

n

)

[protected]

virtual int Job::remainingTime

(

)

const [pure virtual]

Implemented in Transfer, and BTTransfer.

Scheduler* Job::scheduler

(

)

const [inline, protected]

Definition at line 88 of file job.h.

virtual void Job::setDelay

(

int

seconds

)

[pure virtual]

Implemented in Transfer.

void Job::setPolicy

(

Policy

jobPolicy

)

Definition at line 46 of file job.cpp.

void Job::setStatus

(

Status

jobStatus

)

Definition at line 31 of file job.cpp.

virtual void Job::start

(

)

[pure virtual]

Implemented in BTTransfer, ContentFetch, TransferKio, metalink, MmsTransfer, and transferMultiSegKio.

Status Job::status

(

)

const [inline]

Definition at line 78 of file job.h.

virtual void Job::stop

(

)

[pure virtual]

Implemented in BTTransfer, ContentFetch, TransferKio, metalink, MmsTransfer, and transferMultiSegKio.

void Job::write

(

QDomNode *

n

)

[protected]

---

Member Data Documentation

JobQueue* Job::m_jobQueue [protected]

Definition at line 98 of file job.h.

Scheduler* Job::m_scheduler [protected]

Definition at line 99 of file job.h.

---

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

• job.h
• job.cpp

kget

Skip menu "kget"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members
• Related Pages

kdenetwork

Skip menu "kdenetwork"

• kget
• kopete
•   kopete
•   libkopete
•       libpapillon
• krfb

Generated for kdenetwork by doxygen 1.5.4
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