KIO::SimpleJob Class Reference

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

#include <jobclasses.h>

Inheritance diagram for KIO::SimpleJob:

KIO::Job QObject KIO::ListJob KIO::MkdirJob KIO::StatJob KIO::TransferJob KIO::DavJob KIO::MimetypeJob KIO::MultiGetJob KIO::StoredTransferJob

List of all members.


Public Slots

void slotTotalSize (KIO::filesize_t data_size)
virtual void slotError (int, const QString &)

Public Member Functions

 SimpleJob (const KURL &url, int command, const QByteArray &packedArgs, bool showProgressInfo)
const KURL & url () const
virtual void kill (bool quietly=true)
virtual void putOnHold ()
virtual void start (Slave *slave)
void slaveDone ()
Slaveslave () const
int command () const

Static Public Member Functions

static void removeOnHold ()

Protected Slots

virtual void slotFinished ()
void slotWarning (const QString &)
void slotInfoMessage (const QString &s)
void slotConnected ()
void slotProcessedSize (KIO::filesize_t data_size)
void slotSpeed (unsigned long speed)
virtual void slotMetaData (const KIO::MetaData &_metaData)
void slotNeedProgressId ()

Protected Member Functions

virtual void virtual_hook (int id, void *data)
void storeSSLSessionFromJob (const KURL &m_redirectionURL)

Protected Attributes

Slavem_slave
QByteArray m_packedArgs
KURL m_url
KURL m_subUrl
int m_command
KIO::filesize_t m_totalSize

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.


Member Function Documentation

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.

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::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::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.

const KURL& KIO::SimpleJob::url (  )  const [inline]

Returns the SimpleJob's URL.

Returns:
the url

Definition at line 549 of file jobclasses.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys