KIO::TransferJob

Search for usage in LXR

#include <KIO/TransferJob>

Inheritance diagram for KIO::TransferJob:

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 &mimeType)
 
void mimeTypeFound (KIO::Job *job, const QString &mimeType)
 
void permanentRedirection (KIO::Job *job, const QUrl &fromUrl, const QUrl &toUrl)
 
void redirection (KIO::Job *job, const QUrl &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=QPair< QString, QString >(), const QPair< QString, QString > &field2=QPair< 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 percentChanged (KJob *job, unsigned long percent)
 
void processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)
 
void processedAmountChanged (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 totalAmountChanged (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

bool isErrorPage () const
 
QString mimetype () const
 
QUrl redirectUrl () 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
bool isRedirectionHandlingEnabled () const
 
virtual void putOnHold ()
 
void setRedirectionHandlingEnabled (bool handle)
 
const QUrlurl () const
 
- Public Member Functions inherited from KIO::Job
void addMetaData (const QMap< QString, QString > &values)
 
void addMetaData (const QString &key, const QString &value)
 
QStringList detailedErrorStrings (const QUrl *reqUrl=nullptr, int method=-1) const
 
QString errorString () const override
 
void mergeMetaData (const QMap< QString, QString > &values)
 
MetaData metaData () const
 
MetaData outgoingMetaData () const
 
JobparentJob () const
 
QString queryMetaData (const QString &key)
 
void setMetaData (const KIO::MetaData &metaData)
 
void setParentJob (Job *parentJob)
 
void setUiDelegateExtension (JobUiDelegateExtension *extension)
 
void start () override
 
KJobUiDelegateui () const
 
JobUiDelegateExtensionuiDelegateExtension () const
 
- Public Member Functions inherited from KCompositeJob
 KCompositeJob (QObject *parent=nullptr)
 
- Public Member Functions inherited from KJob
 KJob (QObject *parent=nullptr)
 
Capabilities capabilities () const
 
int error () const
 
QString errorText () const
 
bool exec ()
 
bool isAutoDelete () const
 
bool isFinishedNotificationHidden () const
 
bool isStartedWithExec () const
 
bool isSuspended () const
 
unsigned long percent () const
 
Q_SCRIPTABLE qulonglong processedAmount (Unit unit) const
 
void setAutoDelete (bool autodelete)
 
void setFinishedNotificationHidden (bool hide=true)
 
void setUiDelegate (KJobUiDelegate *delegate)
 
Q_SCRIPTABLE qulonglong totalAmount (Unit unit) const
 
KJobUiDelegateuiDelegate () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Slots

virtual void slotData (const QByteArray &data)
 
virtual void slotDataReq ()
 
void slotFinished () override
 
void slotMetaData (const KIO::MetaData &_metaData) override
 
virtual void slotMimetype (const QString &mimetype)
 
virtual void slotRedirection (const QUrl &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)
 

Protected Member Functions

 TransferJob (TransferJobPrivate &dd)
 
bool doResume () override
 
void slotResult (KJob *job) override
 
- Protected Member Functions inherited from KIO::SimpleJob
 SimpleJob (SimpleJobPrivate &dd)
 
bool doKill () override
 
bool doSuspend () override
 
void storeSSLSessionFromJob (const QUrl &m_redirectionURL)
 
- Protected Member Functions inherited from KIO::Job
 Job (JobPrivate &dd)
 
bool addSubjob (KJob *job) override
 
bool removeSubjob (KJob *job) override
 
- Protected Member Functions inherited from KCompositeJob
void clearSubjobs ()
 
bool hasSubjobs () const
 
const QList< KJob * > & subjobs () const
 
- Protected Member Functions inherited from KJob
void emitPercent (qulonglong processedAmount, qulonglong totalAmount)
 
void emitResult ()
 
void emitSpeed (unsigned long speed)
 
bool isFinished () const
 
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 setProgressUnit (Unit unit)
 
void setTotalAmount (Unit unit, qulonglong amount)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Public Types inherited from KJob
typedef QFlags< CapabilityCapabilities
 
enum  Capability
 
enum  Unit
 
- Properties inherited from QObject
 objectName
 
- 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 ()
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from KJob
 Bytes
 
 Directories
 
 Files
 
 Items
 
 Killable
 
 NoCapabilities
 
 Suspendable
 
 UnitsCount
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Attributes inherited from KIO::Job
JobPrivate *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 25 of file transferjob.h.

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 ( )
overrideprotectedvirtual

Reimplemented for internal reasons.

Reimplemented from KIO::SimpleJob.

Definition at line 282 of file transferjob.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 294 of file transferjob.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 MIME type of the URL

Definition at line 206 of file transferjob.cpp.

◆ mimetype [2/2]

void KIO::TransferJob::mimetype ( KIO::Job job,
const QString mimeType 
)
signal

MIME type determined.

Parameters
jobthe job that emitted this signal
mimeTypethe MIME type
Deprecated:
Since 5.78, use mimeTypeFound(KIO::Job *, const QString &)

◆ mimeTypeFound

void KIO::TransferJob::mimeTypeFound ( KIO::Job job,
const QString mimeType 
)
signal

MIME type determined.

Parameters
jobthe job that emitted this signal
mimeTypethe MIME type
Since
5.78

◆ permanentRedirection

void KIO::TransferJob::permanentRedirection ( KIO::Job job,
const QUrl fromUrl,
const QUrl 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 QUrl 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

◆ redirectUrl()

QUrl TransferJob::redirectUrl ( ) const

After the job has finished, it will return the final url in case a redirection has happened.

Returns
the final url that can be empty in case no redirection has happened.
Since
5.0

Definition at line 211 of file transferjob.cpp.

◆ 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:
since 4.2.1, this is unnecessary (it is always false for KIO::get and true for KIO::put)

Definition at line 200 of file transferjob.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 171 of file transferjob.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 161 of file transferjob.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 464 of file transferjob.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 has been received.

See also
slotProcessedSize
slotSpeed
Deprecated:
since 4.2.1, this is unnecessary (it is always false for KIO::get and true for KIO::put)

Definition at line 188 of file transferjob.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 53 of file transferjob.cpp.

◆ slotResult()

void TransferJob::slotResult ( KJob job)
overrideprotectedvirtual

Called when m_subJob finishes.

Parameters
jobthe job that finished

Reimplemented from KCompositeJob.

Definition at line 450 of file transferjob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sun Jun 26 2022 03:50:54 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.