Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KIO::TransferJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::TransferJob:

KIO::SimpleJob KIO::Job KIO::DavJob List of all members.

Signals

void data (KIO::Job *, const QByteArray &data)
void dataReq (KIO::Job *, QByteArray &data)
void redirection (KIO::Job *, const KURL &url)
void permanentRedirection (KIO::Job *, const KURL &fromUrl, const KURL &toUrl)
void mimetype (KIO::Job *, const QString &type)

Public Methods

virtual void start (Slave *slave)
virtual void slotResult (KIO::Job *job)
void suspend ()
void resume ()
bool isSuspended () const
bool isErrorPage () const

Protected Slots

virtual void slotFinished ()

Protected Methods

virtual void virtual_hook (int id, void *data)

Detailed Description

The transfer job pumps data into and/or out of a Slave. Data is sent to the slave on request of the slave (dataReq). If data coming from the slave can not be handled, the reading of data from the slave should be suspended.

Definition at line 565 of file jobclasses.h.


Member Function Documentation

void KIO::TransferJob::data KIO::Job  ,
const QByteArray &    data
[signal]
 

Data from the slave has arrived.

Parameters:
data  data received from the slave. End of data (EOD) has been reached if data.size() == 0

void KIO::TransferJob::dataReq KIO::Job  ,
QByteArray &    data
[signal]
 

Request for data. Please note, that you shouldn't put too large chunks of data in it as this requires copies within the frame work, so you should rather split the data you want to pass here in reasonable chunks (about 1MB maximum)

Parameters:
data  buffer to fill with data to send to the slave. An empty buffer indicates end of data. (EOD)

bool KIO::TransferJob::isErrorPage   const [inline]
 

Returns:
true if we got an (HTML) error page from the server instead of what we asked for. This currently only happens with HTTP urls. Call this from your slot connected to result().

Definition at line 602 of file jobclasses.h.

bool KIO::TransferJob::isSuspended   const [inline]
 

Flow control. Returns true if the job is suspended.

Definition at line 594 of file jobclasses.h.

void KIO::TransferJob::mimetype KIO::Job  ,
const QString &    type
[signal]
 

Mimetype determined

void KIO::TransferJob::permanentRedirection KIO::Job  ,
const KURL   fromUrl,
const KURL   toUrl
[signal]
 

Signals a permanent redirection. The redirection itself is handled internally.

Since:
3.1

void KIO::TransferJob::redirection KIO::Job  ,
const KURL   url
[signal]
 

Signals a redirection. Use to update the URL shown to the user. The redirection itself is handled internally.

void KIO::TransferJob::resume  
 

Flow control. Resume data processing from the slave.

virtual void KIO::TransferJob::slotFinished   [protected, virtual, slot]
 

Called when the slave marks the job as finished.

Reimplemented from KIO::SimpleJob.

Reimplemented in KIO::DavJob.

virtual void KIO::TransferJob::slotResult KIO::Job   job [virtual]
 

Called when m_subJob finishes.

Reimplemented from KIO::Job.

void KIO::TransferJob::suspend  
 

Flow control. Suspend data processing from the slave.


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:34 2003 for kdelibs by doxygen1.2.18