AbstractMetalink Class Reference

#include <abstractmetalink.h>

Inheritance diagram for AbstractMetalink:

Public Slots
virtual void	deinit (Transfer::DeleteOptions options)=0
virtual void	start ()=0
virtual void	stop ()
Public Slots inherited from Transfer
void	setLog (const QString &message, Transfer::LogLevel level=Log_Info)

Public Member Functions
	AbstractMetalink (TransferGroup *parent, TransferFactory *factory, Scheduler *scheduler, const KUrl &src, const KUrl &dest, const QDomElement *e=0)
virtual	~AbstractMetalink ()
QHash< KUrl, QPair< bool, int > >	availableMirrors (const KUrl &file) const
FileModel *	fileModel ()
virtual QList< KUrl >	files () const
int	remainingTime () const
bool	repair (const KUrl &file=KUrl())
void	setAvailableMirrors (const KUrl &file, const QHash< KUrl, QPair< bool, int > > &mirrors)
virtual bool	setDirectory (const KUrl &newDirectory)
virtual Signature *	signature (const KUrl &file)
virtual Verifier *	verifier (const KUrl &file)
Public Member Functions inherited from Transfer
	Transfer (TransferGroup *parent, TransferFactory *factory, Scheduler *scheduler, const KUrl &src, const KUrl &dest, const QDomElement *e=0)
virtual	~Transfer ()
int	averageDownloadSpeed () const
Capabilities	capabilities () const
void	checkShareRatio ()
void	create ()
virtual void	deinit (DeleteOptions options)
const KUrl &	dest () const
void	destroy (DeleteOptions options)
virtual KUrl	directory () const
KIO::filesize_t	downloadedSize () const
int	downloadLimit (SpeedLimit limit) const
int	downloadSpeed () const
virtual int	elapsedTime () const
TransferFactory *	factory () const
TransferGroup *	group () const
TransferHandler *	handler ()
virtual void	init ()
bool	isSelected () const
virtual bool	isStalled () const
virtual bool	isWorking () const
virtual void	load (const QDomElement *element)
const QStringList	log () const
double	maximumShareRatio ()
TransferTreeModel *	model ()
bool	operator< (const Transfer &t2) const
int	percent () const
virtual void	save (const QDomElement &element)
void	setDownloadLimit (int dlLimit, SpeedLimit limit)
void	setMaximumShareRatio (double ratio)
void	setUploadLimit (int ulLimit, SpeedLimit limit)
const KUrl &	source () const
QPixmap	statusPixmap () const
QString	statusText () const
KIO::filesize_t	totalSize () const
KIO::filesize_t	uploadedSize () const
int	uploadLimit (SpeedLimit limit) const
int	uploadSpeed () const
Public Member Functions inherited from Job
	Job (Scheduler *scheduler, JobQueue *parent)
virtual	~Job ()
Error	error () const
JobQueue *	jobQueue ()
Policy	policy () const
virtual void	resolveError (int errorId)
void	setError (const QString &text, const QPixmap &pixmap, ErrorType type=AutomaticRetry, int errorId=-1)
void	setPolicy (Policy jobPolicy)
void	setStatus (Status jobStatus)
virtual void	start ()=0
Status	startStatus () const
Status	status () const
virtual void	stop ()=0
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Slots
void	fileDlgFinished (int result)
void	filesSelected ()
void	slotDataSourceFactoryChange (Transfer::ChangesFlags change)
void	slotRename (const KUrl &oldUrl, const KUrl &newUrl)
virtual void	slotSignatureVerified ()
void	slotUpdateCapabilities ()
void	slotVerified (bool isVerified)

Protected Member Functions
void	recalculateProcessedSize ()
void	recalculateSpeed ()
void	recalculateTotalSize (DataSourceFactory *sender)
virtual void	startMetalink ()=0
void	untickAllFiles ()
void	updateStatus (DataSourceFactory *sender, bool *changeStatus)
Protected Member Functions inherited from Transfer
void	setCapabilities (Capabilities capabilities)
virtual void	setSpeedLimits (int uploadLimit, int downloadLimit)
void	setStatus (Job::Status jobStatus, const QString &text=QString(), const QPixmap &pix=QPixmap())
virtual void	setTransferChange (ChangesFlags change, bool postEvent=false)
Protected Member Functions inherited from Job
void	postJobEvent (Status)
void	read (QDomNode *n)
Scheduler *	scheduler () const
void	setStartStatus (Status jobStatus)
void	write (QDomNode *n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
int	m_averageSpeed
int	m_currentFiles
QHash< KUrl, DataSourceFactory * >	m_dataSourceFactory
FileModel *	m_fileModel
int	m_numFilesSelected
bool	m_ready
int	m_speedCount
int	m_tempAverageSpeed
Protected Attributes inherited from Transfer
KUrl	m_dest
KIO::filesize_t	m_downloadedSize
int	m_downloadLimit
int	m_downloadSpeed
bool	m_isSelected
QStringList	m_log
int	m_percent
KUrl	m_source
KIO::filesize_t	m_totalSize
KIO::filesize_t	m_uploadedSize
int	m_uploadLimit
int	m_uploadSpeed
Protected Attributes inherited from Job
JobQueue *	m_jobQueue
Scheduler *	m_scheduler

Additional Inherited Members
Public Types inherited from Transfer
enum	Capability {   Cap_SpeedLimit = 0x00000001, Cap_MultipleMirrors = 0x00000002, Cap_Resuming = 0x00000004, Cap_Renaming = 0x00000008,   Cap_Moving = 0x00000010, Cap_FindFilesize = 0x00000020 }
typedef int	ChangesFlags
enum	DeleteOption { DeleteTemporaryFiles = 0x00000001, DeleteFiles = 0x00000002 }
enum	LogLevel { Log_Info, Log_Warning, Log_Error }
enum	SpeedLimit { VisibleSpeedLimit = 0x01, InvisibleSpeedLimit = 0x02 }
enum	TransferChange {   Tc_None = 0x00000000, Tc_Source = 0x00000001, Tc_FileName = 0x00000002, Tc_Status = 0x00000004,   Tc_TotalSize = 0x00000008, Tc_Percent = 0x00000010, Tc_DownloadSpeed = 0x00000020, Tc_RemainingTime = 0x00000040,   Tc_UploadSpeed = 0x00000100, Tc_UploadLimit = 0x00000200, Tc_DownloadLimit = 0x00000400, Tc_CanResume = 0x00000800,   Tc_DownloadedSize = 0x00001000, Tc_UploadedSize = 0x00002000, Tc_Log = 0x00004000, Tc_Group = 0x00008000,   Tc_Selection = 0x00010000 }
Public Types inherited from Job
enum	ErrorType { AutomaticRetry, ManualSolve, NotSolveable }
enum	Policy { Start, Stop, None }
enum	Status {   Running = 0, Stopped = 2, Aborted = 3, Finished = 4,   FinishedKeepAlive = 5, Moving = 6 }
Signals inherited from Transfer
void	capabilitiesChanged ()
Static Public Member Functions inherited from Transfer
static QPixmap	statusPixmap (Job::Status status)
static QString	statusText (Job::Status status)
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
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)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

Definition at line 22 of file abstractmetalink.h.

Constructor & Destructor Documentation

AbstractMetalink::AbstractMetalink	(	TransferGroup *	parent,
		TransferFactory *	factory,
		Scheduler *	scheduler,
		const KUrl &	src,
		const KUrl &	dest,
		const QDomElement *	e = 0
	)

Definition at line 38 of file abstractmetalink.cpp.

AbstractMetalink::~AbstractMetalink ( )

virtual

Definition at line 51 of file abstractmetalink.cpp.

Member Function Documentation

QHash< KUrl, QPair< bool, int > > AbstractMetalink::availableMirrors ( const KUrl &  file ) const

virtual

The mirrors that are available bool if it is used, int how many paralell connections are allowed to the mirror.

Parameters

file	the file for which the availableMirrors should be get

Reimplemented from Transfer.

Definition at line 383 of file abstractmetalink.cpp.

virtual void AbstractMetalink::deinit ( Transfer::DeleteOptions  options )

pure virtualslot

void AbstractMetalink::fileDlgFinished ( int  result )

protectedslot

Returns

true if initialising worked

Note

false does not mean that an error happened, it could mean, that the user decided to update the metalink

Definition at line 433 of file abstractmetalink.cpp.

FileModel * AbstractMetalink::fileModel ( )

virtual

Returns

a pointer to the FileModel containing all files of this download

Reimplemented from Transfer.

Definition at line 313 of file abstractmetalink.cpp.

QList< KUrl > AbstractMetalink::files ( ) const

virtual

Returns

all files of this transfer

Reimplemented from Transfer.

Definition at line 308 of file abstractmetalink.cpp.

void AbstractMetalink::filesSelected ( )

protectedslot

Checks if the ticked (not started yet) files exist already on the hd and asks the user how to proceed in that case.

Also calls the according DataSourceFactories setDoDownload(bool) methods.

Definition at line 453 of file abstractmetalink.cpp.

void AbstractMetalink::recalculateProcessedSize ( )

protected

Definition at line 98 of file abstractmetalink.cpp.

void AbstractMetalink::recalculateSpeed ( )

protected

Definition at line 117 of file abstractmetalink.cpp.

void AbstractMetalink::recalculateTotalSize ( DataSourceFactory *  sender )

protected

Definition at line 81 of file abstractmetalink.cpp.

int AbstractMetalink::remainingTime ( ) const

virtual

Reimplemented from Transfer.

Definition at line 136 of file abstractmetalink.cpp.

bool AbstractMetalink::repair ( const KUrl &  file = KUrl() )

virtual

Tries to repair file.

Parameters

file	the file of a download that should be repaired, if not defined all files of a download are going to be repaird

Returns

true if a repair started, false if it was not nescessary

Reimplemented from Transfer.

Definition at line 260 of file abstractmetalink.cpp.

void AbstractMetalink::setAvailableMirrors ( const KUrl &  file, const QHash< KUrl, QPair< bool, int > > &  mirrors  )

virtual

Set the mirrors, int the number of paralell connections to the mirror bool if the mirror should be used.

Parameters

file	the file for which the availableMirrors should be set

Reimplemented from Transfer.

Definition at line 395 of file abstractmetalink.cpp.

bool AbstractMetalink::setDirectory ( const KUrl &  newDirectory )

virtual

Move the download to the new destination.

Parameters

newDirectory

is a directory where the download should be stored

Returns

true if newDestination can be used

Reimplemented from Transfer.

Definition at line 354 of file abstractmetalink.cpp.

Signature * AbstractMetalink::signature ( const KUrl &  file )

virtual

Parameters

file	for which to get the signature

Returns

Signature that allows you to add signatures and verify them

Reimplemented from Transfer.

Definition at line 299 of file abstractmetalink.cpp.

void AbstractMetalink::slotDataSourceFactoryChange ( Transfer::ChangesFlags  change )

protectedslot

Definition at line 55 of file abstractmetalink.cpp.

void AbstractMetalink::slotRename ( const KUrl &  oldUrl, const KUrl &  newUrl  )

protectedslot

Definition at line 341 of file abstractmetalink.cpp.

void AbstractMetalink::slotSignatureVerified ( )

protectedvirtualslot

Definition at line 229 of file abstractmetalink.cpp.

void AbstractMetalink::slotUpdateCapabilities ( )

protectedslot

Definition at line 404 of file abstractmetalink.cpp.

void AbstractMetalink::slotVerified ( bool  isVerified )

protectedslot

Definition at line 198 of file abstractmetalink.cpp.

virtual void AbstractMetalink::start ( )

pure virtualslot

virtual void AbstractMetalink::startMetalink ( )

protectedpure virtual

Starts the type of metalink download.

Implemented in MetalinkXml.

void AbstractMetalink::stop ( )

virtualslot

Definition at line 538 of file abstractmetalink.cpp.

void AbstractMetalink::untickAllFiles ( )

protected

Definition at line 423 of file abstractmetalink.cpp.

void AbstractMetalink::updateStatus ( DataSourceFactory *  sender, bool *  changeStatus  )

protected

Definition at line 144 of file abstractmetalink.cpp.

Verifier * AbstractMetalink::verifier ( const KUrl &  file )

virtual

Parameters

file	for which to get the verifier

Returns

Verifier that allows you to add checksums manually verify a file etc.

Reimplemented from Transfer.

Definition at line 290 of file abstractmetalink.cpp.

Member Data Documentation

int AbstractMetalink::m_averageSpeed

mutableprotected

Definition at line 107 of file abstractmetalink.h.

int AbstractMetalink::m_currentFiles

protected

Definition at line 102 of file abstractmetalink.h.

QHash<KUrl, DataSourceFactory*> AbstractMetalink::m_dataSourceFactory

protected

Definition at line 103 of file abstractmetalink.h.

FileModel* AbstractMetalink::m_fileModel

protected

Definition at line 101 of file abstractmetalink.h.

int AbstractMetalink::m_numFilesSelected

protected

Definition at line 108 of file abstractmetalink.h.

bool AbstractMetalink::m_ready

protected

Definition at line 104 of file abstractmetalink.h.

int AbstractMetalink::m_speedCount

protected

Definition at line 105 of file abstractmetalink.h.

int AbstractMetalink::m_tempAverageSpeed

protected

Definition at line 106 of file abstractmetalink.h.

---

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

• abstractmetalink.h
• abstractmetalink.cpp