Class that provide abstraction for download job of multiple files in sequence. More...

#include <FileDownloader.h>

Inheritance diagram for osmscout::DownloadJob:

Public Slots
void	downloadNextFile ()
void	onDownloadProgress (uint64_t)
void	onJobFailed (QString errorMessage, bool recoverable)
void	onJobFinished (QString path)

Signals
void	canceled ()
void	downloadProgress ()
void	failed (QString error)
void	finished ()

Public Member Functions
void	cancel ()
	Cancel downloading, remove temporary files (of unfinished jobs), emit canceled signal.
	DownloadJob (const DownloadJob &)=delete
	DownloadJob (DownloadJob &&)=delete
	DownloadJob (QNetworkAccessManager *webCtrl, QDir target, bool replaceExisting)
virtual uint64_t	expectedSize () const =0
QDir	getDestinationDirectory () const
QString	getDownloadingFile ()
QString	getError () const
double	getProgress ()
bool	isDone () const
bool	isDownloading () const
bool	isReplaceExisting () const
bool	isSuccessful () const
DownloadJob &	operator= (const DownloadJob &)=delete
DownloadJob &	operator== (const DownloadJob &&)=delete
void	start (const QString &serverBasePath, const QStringList &files)
	~DownloadJob () override

Protected Member Functions
void	clearJobs ()
	Clear all file download jobs, it removes temporary *.download files.

Protected Attributes
bool	canceledByUser {false}
bool	done {false}
uint64_t	downloadedBytes {0}
QString	error
QList< FileDownloader * >	jobs
bool	replaceExisting
bool	started {false}
bool	successful {false}
QDir	target
QNetworkAccessManager *	webCtrl

Detailed Description

Class that provide abstraction for download job of multiple files in sequence.

Constructor & Destructor Documentation

◆ DownloadJob() [1/3]

osmscout::DownloadJob::DownloadJob	(	QNetworkAccessManager *	webCtrl,
		QDir	target,
		bool	replaceExisting )

References replaceExisting, target, and webCtrl.

Referenced by DownloadJob(), DownloadJob(), downloadProgress(), osmscout::MapDownloadJob::MapDownloadJob(), operator=(), operator==(), and osmscout::VoiceDownloadJob::VoiceDownloadJob().

◆ ~DownloadJob()

osmscout::DownloadJob::~DownloadJob ( )

override

References clearJobs().

◆ DownloadJob() [2/3]

osmscout::DownloadJob::DownloadJob ( const DownloadJob & )

delete

References DownloadJob().

◆ DownloadJob() [3/3]

osmscout::DownloadJob::DownloadJob ( DownloadJob && )

delete

References DownloadJob().

Member Function Documentation

◆ cancel()

void osmscout::DownloadJob::cancel ( )

Cancel downloading, remove temporary files (of unfinished jobs), emit canceled signal.

Already downloaded files are retained on disk (this behaviour may be modified by subclass).

References canceledByUser, done, and onJobFailed().

Referenced by operator==().

◆ canceled

void osmscout::DownloadJob::canceled ( )

signal

Referenced by osmscout::VoiceManager::download(), osmscout::MapDownloader::downloadMap(), and onJobFailed().

◆ clearJobs()

void osmscout::DownloadJob::clearJobs ( )

protected

Clear all file download jobs, it removes temporary *.download files.

References jobs.

Referenced by onJobFailed(), ~DownloadJob(), and osmscout::MapDownloadJob::~MapDownloadJob().

◆ downloadNextFile

void osmscout::DownloadJob::downloadNextFile ( )

slot

References done, downloadProgress(), finished(), jobs, and successful.

Referenced by downloadProgress(), onJobFinished(), and start().

◆ downloadProgress

void osmscout::DownloadJob::downloadProgress ( )

signal

References DownloadJob(), downloadNextFile(), onDownloadProgress(), onJobFailed(), onJobFinished(), replaceExisting, target, and webCtrl.

Referenced by downloadNextFile(), osmscout::MapDownloadsModel::onDownloadJobsChanged(), onJobFailed(), and start().

◆ expectedSize()

virtual uint64_t osmscout::DownloadJob::expectedSize ( ) const

pure virtual

Implemented in osmscout::MapDownloadJob, and osmscout::VoiceDownloadJob.

Referenced by getProgress().

◆ failed

void osmscout::DownloadJob::failed ( QString error )

signal

References error.

Referenced by osmscout::VoiceManager::download(), osmscout::MapDownloader::downloadMap(), onJobFailed(), osmscout::MapDownloadJob::start(), and osmscout::VoiceDownloadJob::start().

◆ finished

void osmscout::DownloadJob::finished ( )

signal

Referenced by osmscout::VoiceManager::download(), osmscout::MapDownloader::downloadMap(), and downloadNextFile().

◆ getDestinationDirectory()

QDir osmscout::DownloadJob::getDestinationDirectory ( ) const

inline

References target.

◆ getDownloadingFile()

QString osmscout::DownloadJob::getDownloadingFile ( )

References jobs.

◆ getError()

QString osmscout::DownloadJob::getError ( ) const

inline

References error.

◆ getProgress()

double osmscout::DownloadJob::getProgress ( )

References downloadedBytes, expectedSize(), and jobs.

◆ isDone()

bool osmscout::DownloadJob::isDone ( ) const

inline

References done.

◆ isDownloading()

bool osmscout::DownloadJob::isDownloading ( ) const

inline

References done, and started.

◆ isReplaceExisting()

bool osmscout::DownloadJob::isReplaceExisting ( ) const

inline

References replaceExisting.

Referenced by osmscout::VoiceDownloadJob::start().

◆ isSuccessful()

bool osmscout::DownloadJob::isSuccessful ( ) const

inline

References successful.

◆ onDownloadProgress

void osmscout::DownloadJob::onDownloadProgress ( uint64_t )

slot

References error.

Referenced by downloadProgress(), and start().

◆ onJobFailed

void osmscout::DownloadJob::onJobFailed	(	QString	errorMessage,
		bool	recoverable )

slot

References canceled(), canceledByUser, clearJobs(), done, downloadProgress(), error, failed(), and osmscout::log.

Referenced by cancel(), downloadProgress(), start(), osmscout::MapDownloadJob::start(), and osmscout::VoiceDownloadJob::start().

◆ onJobFinished

void osmscout::DownloadJob::onJobFinished ( QString path )

slot

References downloadedBytes, downloadNextFile(), osmscout::FileDownloader::getBytesDownloaded(), osmscout::FileDownloader::getFilePath(), and jobs.

Referenced by downloadProgress(), and start().

◆ operator=()

DownloadJob & osmscout::DownloadJob::operator= ( const DownloadJob & )

delete

References DownloadJob().

◆ operator==()

DownloadJob & osmscout::DownloadJob::operator== ( const DownloadJob && )

delete

References cancel(), DownloadJob(), and start().

◆ start()

void osmscout::DownloadJob::start	(	const QString &	serverBasePath,
		const QStringList &	files )

References downloadNextFile(), downloadProgress(), osmscout::FileDownloader::error(), osmscout::FileDownloader::finished(), jobs, onDownloadProgress(), onJobFailed(), onJobFinished(), started, target, webCtrl, and osmscout::FileDownloader::writtenBytes().

Referenced by operator==(), osmscout::MapDownloadJob::start(), and osmscout::VoiceDownloadJob::start().

Member Data Documentation

◆ canceledByUser

bool osmscout::DownloadJob::canceledByUser {false}

protected

Referenced by cancel(), and onJobFailed().

◆ done

bool osmscout::DownloadJob::done {false}

protected

Referenced by cancel(), downloadNextFile(), isDone(), isDownloading(), onJobFailed(), osmscout::MapDownloadJob::start(), and osmscout::VoiceDownloadJob::start().

◆ downloadedBytes

uint64_t osmscout::DownloadJob::downloadedBytes {0}

protected

Referenced by getProgress(), and onJobFinished().

◆ error

QString osmscout::DownloadJob::error

protected

Referenced by failed(), getError(), onDownloadProgress(), onJobFailed(), osmscout::MapDownloadJob::start(), and osmscout::VoiceDownloadJob::start().

◆ jobs

QList<FileDownloader*> osmscout::DownloadJob::jobs

protected

Referenced by clearJobs(), downloadNextFile(), getDownloadingFile(), getProgress(), onJobFinished(), and start().

◆ replaceExisting

bool osmscout::DownloadJob::replaceExisting

protected

Referenced by DownloadJob(), downloadProgress(), isReplaceExisting(), osmscout::MapDownloadJob::MapDownloadJob(), and osmscout::VoiceDownloadJob::VoiceDownloadJob().

◆ started

bool osmscout::DownloadJob::started {false}

protected

Referenced by isDownloading(), start(), osmscout::MapDownloadJob::start(), osmscout::VoiceDownloadJob::start(), osmscout::MapDownloadJob::~MapDownloadJob(), and osmscout::VoiceDownloadJob::~VoiceDownloadJob().

◆ successful

bool osmscout::DownloadJob::successful {false}

protected

Referenced by downloadNextFile(), isSuccessful(), osmscout::MapDownloadJob::~MapDownloadJob(), and osmscout::VoiceDownloadJob::~VoiceDownloadJob().

◆ target

QDir osmscout::DownloadJob::target

protected

Referenced by DownloadJob(), downloadProgress(), getDestinationDirectory(), osmscout::MapDownloadJob::MapDownloadJob(), start(), osmscout::MapDownloadJob::start(), osmscout::VoiceDownloadJob::start(), osmscout::VoiceDownloadJob::VoiceDownloadJob(), osmscout::MapDownloadJob::~MapDownloadJob(), and osmscout::VoiceDownloadJob::~VoiceDownloadJob().

◆ webCtrl

QNetworkAccessManager* osmscout::DownloadJob::webCtrl

protected

Referenced by DownloadJob(), downloadProgress(), osmscout::MapDownloadJob::MapDownloadJob(), start(), and osmscout::VoiceDownloadJob::VoiceDownloadJob().

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

Public Slots

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DownloadJob() [1/3]

◆ ~DownloadJob()

◆ DownloadJob() [2/3]

◆ DownloadJob() [3/3]

Member Function Documentation

◆ cancel()

◆ canceled

◆ clearJobs()

◆ downloadNextFile

◆ downloadProgress

◆ expectedSize()

◆ failed

◆ finished

◆ getDestinationDirectory()

◆ getDownloadingFile()

◆ getError()

◆ getProgress()

◆ isDone()

◆ isDownloading()

◆ isReplaceExisting()

◆ isSuccessful()

◆ onDownloadProgress

◆ onJobFailed

◆ onJobFinished

◆ operator=()

◆ operator==()

◆ start()

Member Data Documentation

◆ canceledByUser

◆ done

◆ downloadedBytes

◆ error

◆ jobs

◆ replaceExisting

◆ started

◆ successful

◆ target

◆ webCtrl