KIO::SimpleJob Class Reference

A simple job (one url and one command). More...

#include <jobclasses.h>

Inheritance diagram for KIO::SimpleJob:

[legend]

List of all members.

Public Slots
virtual void	slotError (int, const QString &)
void	slotTotalSize (KIO::filesize_t data_size)
Public Member Functions
int	command () const
virtual void	kill (bool quietly=true)
virtual void	putOnHold ()
	SimpleJob (const KURL &url, int command, const QByteArray &packedArgs, bool showProgressInfo)
Slave *	slave () const
void	slaveDone ()
virtual void	start (Slave *slave)
const KURL &	url () const
	~SimpleJob ()
Static Public Member Functions
static void	removeOnHold ()
Protected Slots
void	slotConnected ()
virtual void	slotFinished ()
void	slotInfoMessage (const QString &s)
virtual void	slotMetaData (const KIO::MetaData &_metaData)
void	slotNeedProgressId ()
void	slotProcessedSize (KIO::filesize_t data_size)
void	slotSpeed (unsigned long speed)
void	slotWarning (const QString &)
Protected Member Functions
void	storeSSLSessionFromJob (const KURL &m_redirectionURL)
virtual void	virtual_hook (int id, void *data)
Protected Attributes
int	m_command
QByteArray	m_packedArgs
Slave *	m_slave
KURL	m_subUrl
KIO::filesize_t	m_totalSize
KURL	m_url

---

Detailed Description

A simple job (one url and one command).

This is the base class for all jobs that are scheduled. Other jobs are high-level jobs (CopyJob, DeleteJob, FileCopyJob...) that manage subjobs but aren't scheduled directly.

Definition at line 528 of file jobclasses.h.

---

Constructor & Destructor Documentation

SimpleJob::SimpleJob	(	const KURL &	url,
		int	command,
		const QByteArray &	packedArgs,
		bool	showProgressInfo
	)

Creates a new simple job.

You don't need to use this constructor, unless you create a new job that inherits from SimpleJob.

Parameters:

	url	the url of the job
	command	the command of the job
	packedArgs	the arguments
	showProgressInfo	true to show progress information to the user

Definition at line 430 of file job.cpp.

SimpleJob::~SimpleJob

(

)

Definition at line 480 of file job.cpp.

---

Member Function Documentation

int KIO::SimpleJob::command

(

)

const [inline]

For internal use only.

Definition at line 593 of file jobclasses.h.

void SimpleJob::kill

(

bool

quietly = true

)

[virtual]

Abort job.

This kills all subjobs and deletes the job.

Parameters:

quietly

if true, Job will emit signal result Should only be set to false when the user kills the job (from kio_uiserver), not when you want to abort a job.

Reimplemented from KIO::Job.

Definition at line 457 of file job.cpp.

void SimpleJob::putOnHold

(

)

[virtual]

Abort job.

Suspends slave to be reused by another job for the same request.

Definition at line 464 of file job.cpp.

void SimpleJob::removeOnHold

(

)

[static]

Discard suspended slave.

Definition at line 475 of file job.cpp.

Slave* KIO::SimpleJob::slave

(

)

const [inline]

For internal use only.

Slave in use by this job.

Definition at line 588 of file jobclasses.h.

void SimpleJob::slaveDone

(

)

For internal use only.

Called to detach a slave from a job.

Definition at line 568 of file job.cpp.

void SimpleJob::slotConnected

(

)

[protected, slot]

Called on a slave's connected signal.

See also:

connected()

Definition at line 639 of file job.cpp.

void SimpleJob::slotError	(	int	error,
		const QString &	errorText
	)			[virtual, slot]

For internal use only.

Called on a slave's error. Made public for the scheduler.

Definition at line 605 of file job.cpp.

void SimpleJob::slotFinished

(

)

[protected, virtual, slot]

Called when the slave marks the job as finished.

Reimplemented in KIO::DavJob, KIO::StatJob, KIO::MkdirJob, KIO::TransferJob, KIO::MultiGetJob, KIO::MimetypeJob, and KIO::ListJob.

Definition at line 576 of file job.cpp.

void SimpleJob::slotInfoMessage

(

const QString &

s

)

[protected, slot]

Called on a slave's info message.

Parameters:

s

the info message

See also:

infoMessage()

Definition at line 634 of file job.cpp.

void SimpleJob::slotMetaData

(

const KIO::MetaData &

_metaData

)

[protected, virtual, slot]

MetaData from the slave is received.

Parameters:

_metaData

the meta data

See also:

metaData()

Reimplemented in KIO::StatJob, KIO::TransferJob, and KIO::ListJob.

Definition at line 677 of file job.cpp.

void SimpleJob::slotNeedProgressId

(

)

[protected, slot]

For internal use only.

Definition at line 644 of file job.cpp.

void SimpleJob::slotProcessedSize

(

KIO::filesize_t

data_size

)

[protected, slot]

Forward signal from the slave.

Parameters:

data_size

the processed size in bytes

See also:

processedSize()

Definition at line 660 of file job.cpp.

void SimpleJob::slotSpeed

(

unsigned long

speed

)

[protected, slot]

Forward signal from the slave.

Parameters:

speed

the speed in bytes/s

See also:

speed()

Definition at line 671 of file job.cpp.

void SimpleJob::slotTotalSize

(

KIO::filesize_t

data_size

)

[slot]

Forward signal from the slave Can also be called by the parent job, when it knows the size.

Parameters:

data_size

the total size

Definition at line 651 of file job.cpp.

void SimpleJob::slotWarning

(

const QString &

errorText

)

[protected, slot]

For internal use only.

Called on a slave's warning.

Definition at line 615 of file job.cpp.

void SimpleJob::start

(

Slave *

slave

)

[virtual]

For internal use only.

Called by the scheduler when a slave gets to work on this job.

Reimplemented in KIO::StatJob, KIO::MkdirJob, KIO::DirectCopyJob, KIO::TransferJob, KIO::MultiGetJob, KIO::MimetypeJob, and KIO::ListJob.

Definition at line 494 of file job.cpp.

void SimpleJob::storeSSLSessionFromJob

(

const KURL &

m_redirectionURL

)

[protected]

Definition at line 682 of file job.cpp.

const KURL& KIO::SimpleJob::url

(

)

const [inline]

Returns the SimpleJob's URL.

Returns:

the url

Definition at line 549 of file jobclasses.h.

void SimpleJob::virtual_hook	(	int	id,
		void *	data
	)			[protected, virtual]

Reimplemented from KIO::Job.

Reimplemented in KIO::StatJob, KIO::MkdirJob, KIO::TransferJob, KIO::MultiGetJob, KIO::MimetypeJob, and KIO::ListJob.

Definition at line 4746 of file job.cpp.

---

Member Data Documentation

int KIO::SimpleJob::m_command [protected]

Definition at line 668 of file jobclasses.h.

QByteArray KIO::SimpleJob::m_packedArgs [protected]

Definition at line 665 of file jobclasses.h.

Slave* KIO::SimpleJob::m_slave [protected]

Definition at line 664 of file jobclasses.h.

KURL KIO::SimpleJob::m_subUrl [protected]

Definition at line 667 of file jobclasses.h.

KIO::filesize_t KIO::SimpleJob::m_totalSize [protected]

Definition at line 669 of file jobclasses.h.

KURL KIO::SimpleJob::m_url [protected]

Definition at line 666 of file jobclasses.h.

---

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

• jobclasses.h
• job.cpp