KIO
KIO::TransferJob Class Reference
The transfer job pumps data into and/or out of a Slave. More...
#include <jobclasses.h>

Signals | |
void | canResume (KIO::Job *job, KIO::filesize_t offset) |
void | data (KIO::Job *job, const QByteArray &data) |
void | dataReq (KIO::Job *job, QByteArray &data) |
void | mimetype (KIO::Job *job, const QString &type) |
void | permanentRedirection (KIO::Job *job, const KUrl &fromUrl, const KUrl &toUrl) |
void | redirection (KIO::Job *job, const KUrl &url) |
Public Member Functions | |
bool | isErrorPage () const |
QString | mimetype () const |
bool | reportDataSent () const |
void | sendAsyncData (const QByteArray &data) |
void | setAsyncDataEnabled (bool enabled) |
void | setModificationTime (const QDateTime &mtime) |
void | setReportDataSent (bool enabled) |
~TransferJob () | |
Protected Slots | |
virtual void | slotData (const QByteArray &data) |
virtual void | slotDataReq () |
virtual void | slotFinished () |
virtual void | slotMetaData (const KIO::MetaData &_metaData) |
virtual void | slotMimetype (const QString &mimetype) |
virtual void | slotRedirection (const KUrl &url) |
Protected Member Functions | |
virtual bool | doResume () |
virtual void | slotResult (KJob *job) |
TransferJob (TransferJobPrivate &dd) |
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 508 of file jobclasses.h.
Constructor & Destructor Documentation
TransferJob::TransferJob | ( | TransferJobPrivate & | dd | ) | [protected] |
Member Function Documentation
void KIO::TransferJob::canResume | ( | KIO::Job * | job, | |
KIO::filesize_t | offset | |||
) | [signal] |
For internal use only.
Emitted if the "put" job found an existing partial file (in which case offset is the size of that file) and emitted by the "get" job if it supports resuming to the given offset - in this case offset
is unused)
void KIO::TransferJob::data | ( | KIO::Job * | job, | |
const QByteArray & | data | |||
) | [signal] |
Data from the slave has arrived.
- Parameters:
-
job the job that emitted this signal data data received from the slave.
void KIO::TransferJob::dataReq | ( | KIO::Job * | 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:
-
job the job that emitted this signal data buffer to fill with data to send to the slave. An empty buffer indicates end of data. (EOD)
bool TransferJob::doResume | ( | ) | [protected, virtual] |
bool TransferJob::isErrorPage | ( | ) | const |
Mimetype determined.
- Parameters:
-
job the job that emitted this signal type the mime type
QString TransferJob::mimetype | ( | ) | const |
void KIO::TransferJob::permanentRedirection | ( | KIO::Job * | job, | |
const KUrl & | fromUrl, | |||
const KUrl & | toUrl | |||
) | [signal] |
Signals a permanent redirection.
The redirection itself is handled internally.
- Parameters:
-
job the job that emitted this signal fromUrl the original URL toUrl the new URL
void KIO::TransferJob::redirection | ( | KIO::Job * | job, | |
const KUrl & | url | |||
) | [signal] |
Signals a redirection.
Use to update the URL shown to the user. The redirection itself is handled internally.
- Parameters:
-
job the job that emitted this signal url the new URL
bool TransferJob::reportDataSent | ( | ) | const |
void TransferJob::sendAsyncData | ( | const QByteArray & | data | ) |
void TransferJob::setAsyncDataEnabled | ( | bool | enabled | ) |
Enable the async data mode.
When async data is enabled, data should be provided to the job by calling sendAsyncData() instead of returning data in the dataReq() signal.
void TransferJob::setModificationTime | ( | const QDateTime & | mtime | ) |
void TransferJob::setReportDataSent | ( | bool | enabled | ) |
void TransferJob::slotData | ( | const QByteArray & | data | ) | [protected, virtual, slot] |
void TransferJob::slotDataReq | ( | ) | [protected, virtual, slot] |
void TransferJob::slotFinished | ( | ) | [protected, virtual, slot] |
Called when the slave marks the job as finished.
Reimplemented from KIO::SimpleJob.
Reimplemented in KIO::DavJob, KIO::MultiGetJob, and KIO::MimetypeJob.
void TransferJob::slotMetaData | ( | const KIO::MetaData & | _metaData | ) | [protected, virtual, slot] |
MetaData from the slave is received.
- Parameters:
-
_metaData the meta data
- See also:
- metaData()
Reimplemented from KIO::SimpleJob.
void TransferJob::slotMimetype | ( | const QString & | mimetype | ) | [protected, virtual, slot] |
void TransferJob::slotRedirection | ( | const KUrl & | url | ) | [protected, virtual, slot] |
void TransferJob::slotResult | ( | KJob * | job | ) | [protected, virtual] |
The documentation for this class was generated from the following files: