KIO::TransferJob Class Reference

The transfer job pumps data into and/or out of a Slave. More...

#include <jobclasses.h>

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 &type)
void	permanentRedirection (KIO::Job *job, const KURL &fromUrl, const KURL &toUrl)
void	redirection (KIO::Job *job, const KURL &url)
Public Member Functions
bool	isErrorPage () const
bool	isSuspended () const
bool	reportDataSent ()
void	resume ()
void	sendAsyncData (const QByteArray &data)
void	setAsyncDataEnabled (bool enabled)
void	setReportDataSent (bool enabled)
virtual void	slotResult (KIO::Job *job)
virtual void	start (Slave *slave)
void	suspend ()
	TransferJob (const KURL &url, int command, const QByteArray &packedArgs, const QByteArray &_staticData, bool showProgressInfo)
Protected Slots
void	slotCanResume (KIO::filesize_t offset)
virtual void	slotData (const QByteArray &data)
virtual void	slotDataReq ()
void	slotErrorPage ()
virtual void	slotFinished ()
virtual void	slotMetaData (const KIO::MetaData &_metaData)
virtual void	slotMimetype (const QString &mimetype)
virtual void	slotNeedSubURLData ()
void	slotPostRedirection ()
virtual void	slotRedirection (const KURL &url)
virtual void	slotSubURLData (KIO::Job *, const QByteArray &)
Protected Member Functions
virtual void	virtual_hook (int id, void *data)
Protected Attributes
bool	m_errorPage
QString	m_mimetype
KURL::List	m_redirectionList
KURL	m_redirectionURL
TransferJob *	m_subJob
bool	m_suspended
QByteArray	staticData

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

Constructor & Destructor Documentation

TransferJob::TransferJob	(	const KURL &	url,
		int	command,
		const QByteArray &	packedArgs,
		const QByteArray &	_staticData,
		bool	showProgressInfo
	)

Do not create a TransferJob.

Use KIO::get() or KIO::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

Definition at line 916 of file job.cpp.

Member Function Documentation

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

For internal use only.

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)

void KIO::TransferJob::data	(	KIO::Job *	job,
		const QByteArray &	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.

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:

	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)

bool KIO::TransferJob::isErrorPage ( ) const [inline]

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

bool KIO::TransferJob::isSuspended ( ) const [inline]

Flow control.

Returns:: true if the job is suspended

Definition at line 921 of file jobclasses.h.

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

Mimetype determined.

Parameters:

	job	the job that emitted this signal
	type	the mime type

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:

	job	the job that emitted this signal
	fromUrl	the original URL
	toUrl	the new URL

Since:: 3.1

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:

	job	the job that emitted this signal
	url	the new URL

bool TransferJob::reportDataSent ( )

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).

Since:: 3.2

Definition at line 1064 of file job.cpp.

void TransferJob::resume ( )

Flow control.

Resume data processing from the slave.

Definition at line 1122 of file job.cpp.

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.

Since:: 3.2

Definition at line 1036 of file job.cpp.

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

Definition at line 1028 of file job.cpp.

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

Definition at line 1056 of file job.cpp.

void TransferJob::slotCanResume ( KIO::filesize_t offset ) [protected, slot]

Definition at line 1193 of file job.cpp.

void TransferJob::slotData ( const QByteArray & data ) [protected, virtual, slot]

Reimplemented in KIO::DavJob, and KIO::MultiGetJob.

Definition at line 930 of file job.cpp.

void TransferJob::slotDataReq ( ) [protected, virtual, slot]

Definition at line 1071 of file job.cpp.

void TransferJob::slotErrorPage ( ) [protected, slot]

Definition at line 1188 of file job.cpp.

void TransferJob::slotFinished ( ) [protected, virtual, slot]

Called when the slave marks the job as finished.

Reimplemented from KIO::SimpleJob.

Reimplemented in KIO::DavJob, KIO::MultiGetJob, and KIO::MimetypeJob.

Definition at line 967 of file job.cpp.

void TransferJob::slotMetaData ( const KIO::MetaData & _metaData ) [protected, virtual, slot]

MetaData from the slave is received.

Parameters:

_metaData

the meta data

See also:: metaData()

Reimplemented from KIO::SimpleJob.

Definition at line 1183 of file job.cpp.

void TransferJob::slotMimetype ( const QString & mimetype ) [protected, virtual, slot]

Reimplemented in KIO::MultiGetJob.

Definition at line 1108 of file job.cpp.

void TransferJob::slotNeedSubURLData ( ) [protected, virtual, slot]

Definition at line 1165 of file job.cpp.

void TransferJob::slotPostRedirection ( ) [protected, slot]

Definition at line 1372 of file job.cpp.

void TransferJob::slotRedirection ( const KURL & url ) [protected, virtual, slot]

Reimplemented in KIO::MultiGetJob.

Definition at line 937 of file job.cpp.

void TransferJob::slotResult ( KIO::Job * job ) [virtual]

Called when m_subJob finishes.

Parameters:

job

the job that finished

Reimplemented from KIO::Job.

Definition at line 1198 of file job.cpp.

void TransferJob::slotSubURLData	(	KIO::Job *	,
		const QByteArray &	data
	)			`[protected, virtual, slot]`

Definition at line 1175 of file job.cpp.

void TransferJob::start ( Slave * slave ) [virtual]

For internal use only.

Called by the scheduler when a slave gets to work on this job.

Parameters:

slave

the slave that starts working on this job

Reimplemented from KIO::SimpleJob.

Reimplemented in KIO::MultiGetJob, and KIO::MimetypeJob.

Definition at line 1129 of file job.cpp.

void TransferJob::suspend ( )

Flow control.

Suspend data processing from the slave.

Definition at line 1115 of file job.cpp.

void TransferJob::virtual_hook	(	int	id,
		void *	data
	)			`[protected, virtual]`

Reimplemented from KIO::SimpleJob.

Reimplemented in KIO::MultiGetJob, and KIO::MimetypeJob.

Definition at line 4755 of file job.cpp.

Member Data Documentation

bool KIO::TransferJob::m_errorPage [protected]

Definition at line 1043 of file jobclasses.h.

QString KIO::TransferJob::m_mimetype [protected]

Definition at line 1047 of file jobclasses.h.

KURL::List KIO::TransferJob::m_redirectionList [protected]

Definition at line 1046 of file jobclasses.h.

KURL KIO::TransferJob::m_redirectionURL [protected]

Definition at line 1045 of file jobclasses.h.

TransferJob* KIO::TransferJob::m_subJob [protected]

Reimplemented in KIO::DavJob.

Definition at line 1048 of file jobclasses.h.

bool KIO::TransferJob::m_suspended [protected]

Reimplemented in KIO::DavJob.

Definition at line 1042 of file jobclasses.h.

QByteArray KIO::TransferJob::staticData [protected]

Definition at line 1044 of file jobclasses.h.

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

kio

KIO::TransferJob Class Reference

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

kio

API Reference