#include <jobclasses.h>
Signals | |
void | data (TDEIO::Job *job, const TQByteArray &data) |
void | dataReq (TDEIO::Job *job, TQByteArray &data) |
void | redirection (TDEIO::Job *job, const KURL &url) |
void | permanentRedirection (TDEIO::Job *job, const KURL &fromUrl, const KURL &toUrl) |
void | mimetype (TDEIO::Job *job, const TQString &type) |
void | canResume (TDEIO::Job *job, TDEIO::filesize_t offset) |
Signals inherited from TDEIO::Job | |
void | result (TDEIO::Job *job) |
void | canceled (TDEIO::Job *job) |
void | infoMessage (TDEIO::Job *job, const TQString &msg) |
void | warning (TDEIO::Job *job, const TQString &msg) |
void | connected (TDEIO::Job *job) |
void | percent (TDEIO::Job *job, unsigned long percent) |
void | totalSize (TDEIO::Job *job, TDEIO::filesize_t size) |
void | processedSize (TDEIO::Job *job, TDEIO::filesize_t size) |
void | speed (TDEIO::Job *job, unsigned long speed) |
Public Member Functions | |
TransferJob (const KURL &url, int command, const TQByteArray &packedArgs, const TQByteArray &_staticData, bool showProgressInfo) | |
virtual void | start (Slave *slave) |
virtual void | slotResult (TDEIO::Job *job) |
void | suspend () |
void | resume () |
bool | isSuspended () const |
bool | isErrorPage () const |
void | setAsyncDataEnabled (bool enabled) |
void | sendAsyncData (const TQByteArray &data) |
void | setReportDataSent (bool enabled) |
bool | reportDataSent () |
Public Member Functions inherited from TDEIO::SimpleJob | |
SimpleJob (const KURL &url, int command, const TQByteArray &packedArgs, bool showProgressInfo) | |
const KURL & | url () const |
virtual void | kill (bool quietly=true) |
virtual void | putOnHold () |
void | slaveDone () |
Slave * | slave () const |
int | command () const |
Public Member Functions inherited from TDEIO::Job | |
int | error () const |
int | progressId () const |
const TQString & | errorText () const |
TQString | errorString () const |
TQStringList | detailedErrorStrings (const KURL *reqUrl=0L, int method=-1) const |
void | showErrorDialog (TQWidget *parent=0L) |
void | setAutoErrorHandlingEnabled (bool enable, TQWidget *parentWidget=0) |
bool | isAutoErrorHandlingEnabled () const |
void | setAutoWarningHandlingEnabled (bool enable) |
bool | isAutoWarningHandlingEnabled () const |
void | setInteractive (bool enable) |
bool | isInteractive () const |
void | setWindow (TQWidget *window) |
TQWidget * | window () const |
void | updateUserTimestamp (unsigned long time) |
void | setParentJob (Job *parentJob) |
Job * | parentJob () const |
void | setMetaData (const TDEIO::MetaData &metaData) |
void | addMetaData (const TQString &key, const TQString &value) |
void | addMetaData (const TQMap< TQString, TQString > &values) |
void | mergeMetaData (const TQMap< TQString, TQString > &values) |
MetaData | outgoingMetaData () const |
MetaData | metaData () const |
TQString | queryMetaData (const TQString &key) |
TDEIO::filesize_t | getProcessedSize () |
Protected Slots | |
virtual void | slotRedirection (const KURL &url) |
virtual void | slotFinished () |
virtual void | slotData (const TQByteArray &data) |
virtual void | slotDataReq () |
virtual void | slotMimetype (const TQString &mimetype) |
virtual void | slotNeedSubURLData () |
virtual void | slotSubURLData (TDEIO::Job *, const TQByteArray &) |
virtual void | slotMetaData (const TDEIO::MetaData &_metaData) |
void | slotErrorPage () |
void | slotCanResume (TDEIO::filesize_t offset) |
void | slotPostRedirection () |
Protected Slots inherited from TDEIO::SimpleJob | |
virtual void | slotFinished () |
void | slotWarning (const TQString &) |
void | slotInfoMessage (const TQString &s) |
void | slotConnected () |
void | slotProcessedSize (TDEIO::filesize_t data_size) |
void | slotSpeed (unsigned long speed) |
virtual void | slotMetaData (const TDEIO::MetaData &_metaData) |
void | slotNeedProgressId () |
Protected Slots inherited from TDEIO::Job | |
void | slotSpeed (TDEIO::Job *job, unsigned long speed) |
void | slotInfoMessage (TDEIO::Job *job, const TQString &msg) |
void | slotSpeedTimeout () |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
Protected Member Functions inherited from TDEIO::SimpleJob | |
void | storeSSLSessionFromJob (const KURL &m_redirectionURL) |
Protected Member Functions inherited from TDEIO::Job | |
Job (bool showProgressInfo) | |
virtual void | addSubjob (Job *job, bool inheritMetaData=true) |
virtual void | removeSubjob (Job *job) |
void | removeSubjob (Job *job, bool mergeMetaData, bool emitResultIfLast) |
void | emitPercent (TDEIO::filesize_t processedSize, TDEIO::filesize_t totalSize) |
void | emitSpeed (unsigned long speed) |
void | emitResult () |
void | setProcessedSize (TDEIO::filesize_t size) |
unsigned long | userTimestamp () const |
int & | extraFlags () |
Protected Attributes | |
bool | m_suspended |
bool | m_errorPage |
TQByteArray | staticData |
KURL | m_redirectionURL |
KURL::List | m_redirectionList |
TQString | m_mimetype |
TransferJob * | m_subJob |
Protected Attributes inherited from TDEIO::SimpleJob | |
Slave * | m_slave |
TQByteArray | m_packedArgs |
KURL | m_url |
KURL | m_subUrl |
int | m_command |
TDEIO::filesize_t | m_totalSize |
Protected Attributes inherited from TDEIO::Job | |
TQPtrList< Job > | subjobs |
int | m_error |
TQString | m_errorText |
unsigned long | m_percent |
int | m_progressId |
TQTimer * | m_speedTimer |
TQGuardedPtr< TQWidget > | m_window |
MetaData | m_outgoingMetaData |
MetaData | m_incomingMetaData |
Additional Inherited Members | |
Public Slots inherited from TDEIO::SimpleJob | |
void | slotTotalSize (TDEIO::filesize_t data_size) |
virtual void | slotError (int, const TQString &) |
Static Public Member Functions inherited from TDEIO::SimpleJob | |
static void | removeOnHold () |
Protected Types inherited from TDEIO::Job | |
enum | { EF_TransferJobAsync = (1 << 0) , EF_TransferJobNeedData = (1 << 1) , EF_TransferJobDataSent = (1 << 2) , EF_ListJobUnrestricted = (1 << 3) } |
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 874 of file jobclasses.h.
Constructor & Destructor Documentation
◆ TransferJob()
TransferJob::TransferJob | ( | const KURL & | url, |
int | command, | ||
const TQByteArray & | packedArgs, | ||
const TQByteArray & | _staticData, | ||
bool | showProgressInfo | ||
) |
Do not create a TransferJob.
Use TDEIO::get() or TDEIO::put() instead.
- Parameters
-
url the url to get or put command the command to issue packedArgs the arguments _staticData additional data to transmit (e.g. in a HTTP Post) showProgressInfo true to show progress information to the user
Member Function Documentation
◆ 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.
◆ dataReq
|
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)
◆ isErrorPage()
|
inline |
Checks whether we got an error page.
This currently only happens with HTTP urls. Call this from your slot connected to result().
@return true if we got an (HTML) error page from the server instead of what we asked for.
Definition at line 930 of file jobclasses.h.
◆ isSuspended()
|
inline |
◆ mimetype
|
signal |
Mimetype determined.
- Parameters
-
job the job that emitted this signal type the mime type
◆ permanentRedirection
|
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
- Since
- 3.1
◆ redirection
|
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
◆ reportDataSent()
bool TransferJob::reportDataSent | ( | ) |
◆ resume()
void TransferJob::resume | ( | ) |
◆ sendAsyncData()
void TransferJob::sendAsyncData | ( | const TQByteArray & | data | ) |
◆ 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.
- Since
- 3.2
◆ 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
- Since
- 3.2
◆ slotResult()
|
virtual |
◆ suspend()
void TransferJob::suspend | ( | ) |
The documentation for this class was generated from the following files: