Metalink Class Reference

#include <metalink.h>

Inheritance diagram for Metalink:

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

Public Member Functions
	Metalink (TransferGroup *parent, TransferFactory *factory, Scheduler *scheduler, const KUrl &src, const KUrl &dest, const QDomElement *e=0)
	~Metalink ()
QHash< KUrl, QPair< bool, int > >	availableMirrors (const KUrl &file) const
FileModel *	fileModel ()
virtual QList< KUrl >	files () const
void	load (const QDomElement *e)
int	remainingTime () const
bool	repair (const KUrl &file=KUrl())
void	save (const QDomElement &element)
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
const QStringList	log () const
double	maximumShareRatio ()
TransferTreeModel *	model ()
bool	operator< (const Transfer &t2) const
int	percent () const
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

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

Detailed Description

Definition at line 23 of file metalink.h.

Constructor & Destructor Documentation

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

Definition at line 43 of file metalink.cpp.

Metalink::~Metalink

(

)

Definition at line 57 of file metalink.cpp.

Member Function Documentation

QHash< KUrl, QPair< bool, int > > Metalink::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 821 of file metalink.cpp.

void Metalink::deinit ( Transfer::DeleteOptions  options )

slot

Definition at line 282 of file metalink.cpp.

FileModel * Metalink::fileModel ( )

virtual

Returns

a pointer to the FileModel containing all files of this download

Reimplemented from Transfer.

Definition at line 660 of file metalink.cpp.

QList< KUrl > Metalink::files ( ) const

virtual

Returns

all files of this transfer

Reimplemented from Transfer.

Definition at line 655 of file metalink.cpp.

void Metalink::load ( const QDomElement *  element )

virtual

Loads the transfer's info from the QDomElement.

Parameters

element

The pointer to the QDomNode where info will be loaded from

Reimplemented from Transfer.

Definition at line 573 of file metalink.cpp.

int Metalink::remainingTime ( ) const

virtual

Reimplemented to return a time based on the average of the last three speeds.

Reimplemented from Transfer.

Definition at line 404 of file metalink.cpp.

bool Metalink::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 536 of file metalink.cpp.

void Metalink::save ( const QDomElement &  element )

virtual

Saves this transfer to the given QDomNode.

Parameters

element

The pointer to the QDomNode where the transfer will be saved

Reimplemented from Transfer.

Definition at line 623 of file metalink.cpp.

void Metalink::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 834 of file metalink.cpp.

bool Metalink::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 789 of file metalink.cpp.

Signature * Metalink::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 646 of file metalink.cpp.

void Metalink::start ( )

slot

Definition at line 61 of file metalink.cpp.

void Metalink::stop ( )

slot

Definition at line 303 of file metalink.cpp.

Verifier * Metalink::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 636 of file metalink.cpp.

---

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

• metalink.h
• metalink.cpp