KIO::StoredTransferJob Class Reference

#include <jobclasses.h>

Inheritance diagram for KIO::StoredTransferJob:

Public Member Functions
	~StoredTransferJob ()
QByteArray	data () const
void	setData (const QByteArray &arr)
Public Member Functions inherited from KIO::TransferJob
	~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 QString &key, const QString &value)
void	addMetaData (const QMap< QString, QString > &values)
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 ()
virtual	~KJob ()
Capabilities	capabilities () const
int	error () const
QString	errorText () const
bool	exec ()
bool	isAutoDelete () const
bool	isSuspended () const
	KJob (QObject *parent=0)
unsigned long	percent () const
qulonglong	processedAmount (Unit unit) const
void	setAutoDelete (bool autodelete)
void	setUiDelegate (KJobUiDelegate *delegate)
qulonglong	totalAmount (Unit unit) const
KJobUiDelegate *	uiDelegate () const

Protected Member Functions
	StoredTransferJob (StoredTransferJobPrivate &dd)
Protected Member Functions inherited from KIO::TransferJob
	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	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	removeSubjob (KJob *job)
Protected Member Functions inherited from KCompositeJob
	KCompositeJob (KCompositeJobPrivate &dd, QObject *parent)
void	clearSubjobs ()
void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)
void	emitResult ()
void	emitSpeed (unsigned long speed)
bool	hasSubjobs ()
	KJob (KJobPrivate &dd, QObject *parent)
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)
const QList< KJob * > &	subjobs () const

Additional Inherited Members
Public Types inherited from KCompositeJob
enum	Capability
enum	KillVerbosity
enum	Unit
Public Slots inherited from KIO::SimpleJob
void	slotError (int, const QString &)
Public Slots inherited from KCompositeJob
bool	kill (KillVerbosity verbosity=Quietly)
bool	resume ()
bool	suspend ()
Signals inherited from KIO::TransferJob
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 KCompositeJob
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())
Static Public Member Functions inherited from KIO::SimpleJob
static void	removeOnHold ()
Protected Slots inherited from KIO::TransferJob
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)
Protected Attributes inherited from KCompositeJob
KJobPrivate *const	d_ptr

Detailed Description

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

For KIO::storedGet it puts the data into the member QByteArray, 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 QByteArray can potentially require a lot of memory.

For KIO::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 QByteArray can potentially require a lot of memory.

Definition at line 743 of file jobclasses.h.

Constructor & Destructor Documentation

StoredTransferJob::~StoredTransferJob

(

)

Definition at line 1733 of file job.cpp.

StoredTransferJob::StoredTransferJob ( StoredTransferJobPrivate &  dd )

protected

Definition at line 1724 of file job.cpp.

Member Function Documentation

QByteArray StoredTransferJob::data

(

)

const

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

void StoredTransferJob::setData

(

const QByteArray &

arr

)

Set data to be uploaded.

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

Definition at line 1737 of file job.cpp.

---

The documentation for this class was generated from the following files:

• jobclasses.h
• job.cpp