• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KIO

  • KIO
  • TransferJob
Signals | Public Member Functions | Protected Slots | Protected Member Functions | List of all members
KIO::TransferJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::TransferJob:
KIO::SimpleJob KIO::Job KCompositeJob KJob QObject KIO::DavJob KIO::MimetypeJob KIO::MultiGetJob KIO::SpecialJob KIO::StoredTransferJob

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)
 
- Signals inherited from KIO::Job
void canceled (KJob *job)
 
void connected (KIO::Job *job)
 
- Signals inherited from KJob
void description (KJob *job, const QString &title, const QPair< QString, QString > &field1=qMakePair(QString(), QString()), const QPair< QString, QString > &field2=qMakePair(QString(), QString()))
 
void finished (KJob *job)
 
void infoMessage (KJob *job, const QString &plain, const QString &rich=QString())
 
void percent (KJob *job, unsigned long percent)
 
void processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)
 
void processedSize (KJob *job, qulonglong size)
 
void result (KJob *job)
 
void resumed (KJob *job)
 
void speed (KJob *job, unsigned long speed)
 
void suspended (KJob *job)
 
void totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)
 
void totalSize (KJob *job, qulonglong size)
 
void warning (KJob *job, const QString &plain, const QString &rich=QString())
 

Public Member Functions

 ~TransferJob ()
 
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)
 
void setTotalSize (KIO::filesize_t bytes)
 
- Public Member Functions inherited from KIO::SimpleJob
 ~SimpleJob ()
 
bool isRedirectionHandlingEnabled () const
 
virtual void putOnHold ()
 
void setRedirectionHandlingEnabled (bool handle)
 
const KUrl & url () const
 
- Public Member Functions inherited from KIO::Job
virtual ~Job ()
 
void addMetaData (const QMap< QString, QString > &values)
 
void addMetaData (const QString &key, const QString &value)
 
QStringList detailedErrorStrings (const KUrl *reqUrl=0L, int method=-1) const
 
QString errorString () const
 
bool isInteractive () const
 
void mergeMetaData (const QMap< QString, QString > &values)
 
MetaData metaData () const
 
MetaData outgoingMetaData () const
 
Job * parentJob () const
 
QString queryMetaData (const QString &key)
 
void setMetaData (const KIO::MetaData &metaData)
 
void setParentJob (Job *parentJob)
 
void showErrorDialog (QWidget *parent=0)
 
void start ()
 
JobUiDelegate * ui () const
 
- Public Member Functions inherited from KCompositeJob
 KCompositeJob (QObject *parent=0)
 
virtual ~KCompositeJob ()
 
- Public Member Functions inherited from KJob
 KJob (QObject *parent=0)
 
virtual ~KJob ()
 
Capabilities capabilities () const
 
int error () const
 
virtual QString errorString () const
 
QString errorText () const
 
bool exec ()
 
bool isAutoDelete () const
 
bool isSuspended () const
 
unsigned long percent () const
 
qulonglong processedAmount (Unit unit) const
 
void setAutoDelete (bool autodelete)
 
void setUiDelegate (KJobUiDelegate *delegate)
 
virtual void start ()=0
 
qulonglong totalAmount (Unit unit) const
 
KJobUiDelegate * uiDelegate () const
 

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 Slots inherited from KIO::SimpleJob
virtual void slotFinished ()
 
virtual void slotMetaData (const KIO::MetaData &_metaData)
 
virtual void slotWarning (const QString &)
 
- Protected Slots inherited from KCompositeJob
virtual void slotInfoMessage (KJob *job, const QString &plain, const QString &rich)
 
virtual void slotResult (KJob *job)
 

Protected Member Functions

 TransferJob (TransferJobPrivate &dd)
 
virtual bool doResume ()
 
virtual void slotResult (KJob *job)
 
- Protected Member Functions inherited from KIO::SimpleJob
 SimpleJob (SimpleJobPrivate &dd)
 
virtual bool doKill ()
 
virtual bool doResume ()
 
virtual bool doSuspend ()
 
void storeSSLSessionFromJob (const KUrl &m_redirectionURL)
 
- Protected Member Functions inherited from KIO::Job
 Job ()
 
 Job (JobPrivate &dd)
 
virtual bool addSubjob (KJob *job)
 
virtual bool doKill ()
 
virtual bool doResume ()
 
virtual bool doSuspend ()
 
virtual bool removeSubjob (KJob *job)
 
- Protected Member Functions inherited from KCompositeJob
 KCompositeJob (KCompositeJobPrivate &dd, QObject *parent)
 
virtual bool addSubjob (KJob *job)
 
void clearSubjobs ()
 
bool hasSubjobs ()
 
virtual bool removeSubjob (KJob *job)
 
const QList< KJob * > & subjobs () const
 
- Protected Member Functions inherited from KJob
 KJob (KJobPrivate &dd, QObject *parent)
 
virtual bool doKill ()
 
virtual bool doResume ()
 
virtual bool doSuspend ()
 
void emitPercent (qulonglong processedAmount, qulonglong totalAmount)
 
void emitResult ()
 
void emitSpeed (unsigned long speed)
 
void setCapabilities (Capabilities capabilities)
 
void setError (int errorCode)
 
void setErrorText (const QString &errorText)
 
void setPercent (unsigned long percentage)
 
void setProcessedAmount (Unit unit, qulonglong amount)
 
void setTotalAmount (Unit unit, qulonglong amount)
 

Additional Inherited Members

- Public Types inherited from KJob
enum  Capability
 
enum  KillVerbosity
 
enum  Unit
 
- Public Slots inherited from KIO::SimpleJob
void slotError (int, const QString &)
 
- Public Slots inherited from KJob
bool kill (KillVerbosity verbosity=Quietly)
 
bool resume ()
 
bool suspend ()
 
- Static Public Member Functions inherited from KIO::SimpleJob
static void removeOnHold ()
 
- Public Attributes inherited from KJob
 Bytes
 
 Directories
 
 EmitResult
 
 Files
 
 Killable
 
 KilledJobError
 
 NoCapabilities
 
 NoError
 
 Quietly
 
 Suspendable
 
 UserDefinedError
 
- Protected Attributes inherited from KJob
KJobPrivate *const d_ptr
 

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 555 of file jobclasses.h.

Constructor & Destructor Documentation

◆ ~TransferJob()

TransferJob::~TransferJob ( )

Definition at line 983 of file job.cpp.

◆ TransferJob()

TransferJob::TransferJob ( TransferJobPrivate &  dd)
protected

Definition at line 974 of file job.cpp.

Member Function Documentation

◆ canResume

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

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)

◆ data

void KIO::TransferJob::data ( KIO::Job *  job,
const QByteArray &  data 
)
signal

Data from the slave has arrived.

Parameters
jobthe job that emitted this signal
datadata 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.

◆ dataReq

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
jobthe job that emitted this signal
databuffer to fill with data to send to the slave. An empty buffer indicates end of data. (EOD)

◆ doResume()

bool TransferJob::doResume ( )
protectedvirtual

Reimplemented for internal reasons.

Reimplemented from KIO::SimpleJob.

Definition at line 1227 of file job.cpp.

◆ isErrorPage()

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 1237 of file job.cpp.

◆ mimetype() [1/2]

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 1156 of file job.cpp.

◆ mimetype [2/2]

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

Mimetype determined.

Parameters
jobthe job that emitted this signal
typethe mime type

◆ permanentRedirection

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
jobthe job that emitted this signal
fromUrlthe original URL
toUrlthe new URL

◆ redirection

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
jobthe job that emitted this signal
urlthe new URL

◆ reportDataSent()

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)

Deprecated:
not needed, this is false for KIO::get and true for KIO::put, automatically since KDE-4.2.1 (and not useful as public API)

Definition at line 1150 of file job.cpp.

◆ sendAsyncData()

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 1122 of file job.cpp.

◆ setAsyncDataEnabled()

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 1113 of file job.cpp.

◆ setModificationTime()

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 1364 of file job.cpp.

◆ setReportDataSent()

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
Deprecated:
not needed, this is false for KIO::get and true for KIO::put, automatically since KDE-4.2.1

Definition at line 1139 of file job.cpp.

◆ setTotalSize()

void KIO::TransferJob::setTotalSize ( KIO::filesize_t  bytes)

Set the total size of data that we are going to send in a put job.

Helps getting proper progress information.

Since
4.2.1

Definition at line 1003 of file job.cpp.

◆ slotData

void TransferJob::slotData ( const QByteArray &  data)
protectedvirtualslot

Definition at line 988 of file job.cpp.

◆ slotDataReq

void TransferJob::slotDataReq ( )
protectedvirtualslot

Definition at line 1162 of file job.cpp.

◆ slotFinished

void TransferJob::slotFinished ( )
protectedvirtualslot

Definition at line 1043 of file job.cpp.

◆ slotMetaData

void TransferJob::slotMetaData ( const KIO::MetaData &  _metaData)
protectedvirtualslot

Definition at line 1303 of file job.cpp.

◆ slotMimetype

void TransferJob::slotMimetype ( const QString &  mimetype)
protectedvirtualslot

Definition at line 1200 of file job.cpp.

◆ slotRedirection

void TransferJob::slotRedirection ( const KUrl &  url)
protectedvirtualslot

Definition at line 1009 of file job.cpp.

◆ slotResult()

void TransferJob::slotResult ( KJob *  job)
protectedvirtual

Called when m_subJob finishes.

Parameters
jobthe job that finished

Reimplemented from KCompositeJob.

Definition at line 1349 of file job.cpp.


The documentation for this class was generated from the following files:
  • jobclasses.h
  • job.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIO

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

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal