• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KIO

KIO::TransferJob

KIO::TransferJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::TransferJob:

Inheritance graph
[legend]

List of all members.


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.


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)

Constructor & Destructor Documentation

TransferJob::~TransferJob (  ) 

Definition at line 918 of file job.cpp.

TransferJob::TransferJob ( TransferJobPrivate &  dd  )  [protected]

Definition at line 913 of file job.cpp.


Member Function Documentation

void KIO::TransferJob::canResume ( KIO::Job *  job,
KIO::filesize_t  offset 
) [signal]

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.
End of data (EOD) has been reached if data.size() == 0, however, you should not be certain of data.size() == 0 ever happening (e.g. in case of an error), so you should rely on result() instead.

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]

Reimplemented for internal reasons.

Reimplemented from KIO::SimpleJob.

Definition at line 1130 of file job.cpp.

bool TransferJob::isErrorPage (  )  const

Checks whether we got an error page.

This currently only happens with HTTP urls. Call this from your slot connected to result().

Returns:
true if we got an (HTML) error page from the server instead of what we asked for.

Definition at line 1140 of file job.cpp.

void KIO::TransferJob::mimetype ( KIO::Job *  job,
const QString &  type 
) [signal]

Mimetype determined.

Parameters:
job the job that emitted this signal
type the mime type

QString TransferJob::mimetype (  )  const

Call this in the slot connected to result, and only after making sure no error happened.

Returns:
the mimetype of the URL

Definition at line 1063 of file job.cpp.

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

Returns whether the job reports the amount of data that has been sent (true), or whether the job reports the amount of data that has been received (false).

Definition at line 1058 of file job.cpp.

void TransferJob::sendAsyncData ( const QByteArray &  data  ) 

Provide data to the job when async data is enabled.

Should be called exactly once after receiving a dataReq signal Sending an empty block indicates end of data.

Definition at line 1033 of file job.cpp.

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.

Definition at line 1024 of file job.cpp.

void TransferJob::setModificationTime ( const QDateTime &  mtime  ) 

Sets the modification time of the file to be created (by KIO::put) Note that some kioslaves might ignore this.

Definition at line 1235 of file job.cpp.

void TransferJob::setReportDataSent ( bool  enabled  ) 

When enabled, the job reports the amount of data that has been sent, instead of the amount of data that that has been received.

See also:
slotProcessedSize

slotSpeed

Definition at line 1049 of file job.cpp.

void TransferJob::slotData ( const QByteArray &  data  )  [protected, virtual, slot]

Reimplemented in KIO::DavJob, and KIO::MultiGetJob.

Definition at line 923 of file job.cpp.

void TransferJob::slotDataReq (  )  [protected, virtual, slot]

Definition at line 1070 of file job.cpp.

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.

Definition at line 962 of file job.cpp.

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.

Definition at line 1202 of file job.cpp.

void TransferJob::slotMimetype ( const QString &  mimetype  )  [protected, virtual, slot]

Reimplemented in KIO::MultiGetJob.

Definition at line 1108 of file job.cpp.

void TransferJob::slotRedirection ( const KUrl &  url  )  [protected, virtual, slot]

Reimplemented in KIO::MultiGetJob.

Definition at line 931 of file job.cpp.

void TransferJob::slotResult ( KJob *  job  )  [protected, virtual]

Called when m_subJob finishes.

Parameters:
job the job that finished

Reimplemented from KCompositeJob.

Definition at line 1220 of file job.cpp.


The documentation for this class was generated from the following files:
  • jobclasses.h
  • job.cpp

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs 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