• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeio/tdeio
 

tdeio/tdeio

  • TDEIO
  • StoredTransferJob
Public Member Functions | List of all members
TDEIO::StoredTransferJob Class Reference

#include <jobclasses.h>

Inheritance diagram for TDEIO::StoredTransferJob:
TDEIO::TransferJob TDEIO::SimpleJob TDEIO::Job

Public Member Functions

 StoredTransferJob (const KURL &url, int command, const TQByteArray &packedArgs, const TQByteArray &_staticData, bool showProgressInfo)
 
void setData (const TQByteArray &arr)
 
TQByteArray data () const
 
- Public Member Functions inherited from TDEIO::TransferJob
 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 ()
 

Additional Inherited Members

- Public Slots inherited from TDEIO::SimpleJob
void slotTotalSize (TDEIO::filesize_t data_size)
 
virtual void slotError (int, const TQString &)
 
- Signals inherited from TDEIO::TransferJob
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)
 
- 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) }
 
- Protected Slots inherited from TDEIO::TransferJob
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 inherited from TDEIO::TransferJob
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 inherited from TDEIO::TransferJob
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
 

Detailed Description

StoredTransferJob is a TransferJob (for downloading or uploading data) that also stores a TQByteArray with the data, making it simpler to use than the standard TransferJob.

For TDEIO::storedGet it puts the data into the member TQByteArray, so the user of this class can get hold of the whole data at once by calling data() when the result signal is emitted. You should only use StoredTransferJob to download data if you cannot process the data by chunks while it's being downloaded, since storing everything in a TQByteArray can potentially require a lot of memory.

For TDEIO::storedPut the user of this class simply provides the bytearray from the start, and the job takes care of uploading it. You should only use StoredTransferJob to upload data if you cannot provide the in chunks while it's being uploaded, since storing everything in a TQByteArray can potentially require a lot of memory.

Since
3.3

Definition at line 1074 of file jobclasses.h.

Constructor & Destructor Documentation

StoredTransferJob::StoredTransferJob ( const KURL &  url,
int  command,
const TQByteArray &  packedArgs,
const TQByteArray &  _staticData,
bool  showProgressInfo 
)

Do not create a StoredTransferJob.

Use storedGet() or storedPut() instead.

Parameters
urlthe url to get or put
commandthe command to issue
packedArgsthe arguments
_staticDataadditional data to transmit (e.g. in a HTTP Post)
showProgressInfotrue to show progress information to the user

Definition at line 1425 of file job.cpp.

Member Function Documentation

TQByteArray TDEIO::StoredTransferJob::data ( ) const
inline

Get hold of the downloaded data.

This is for get jobs. You're supposed to call this only from the slot connected to the result() signal.

Definition at line 1103 of file jobclasses.h.

void StoredTransferJob::setData ( const TQByteArray &  arr)

Set data to be uploaded.

This is for put jobs. Automatically called by TDEIO::storedPut(const TQByteArray &, ...), do not call this yourself.

Definition at line 1438 of file job.cpp.


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

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  •     tdecore
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  • tdeioslave
  •   http
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeio/tdeio by doxygen 1.8.8
This website is maintained by Timothy Pearson.