>Provides file download facility More...

Inheritance diagram for FileDownloader:

Public Member Functions
	FileDownloader (const BufferStringSet &urls, const BufferStringSet &outputpaths)

	FileDownloader (const char *url)

	FileDownloader (const char url, DataBuffer db)

	~FileDownloader ()

od_int64	getDownloadSize ()

int	nextStep ()

od_int64	nrDone () const

od_int64	totalNr () const

uiString	uiMessage () const
	will be message() again in 7.x More...

uiString	uiNrDoneText () const
	will be nrDoneText() in 7.x More...

Public Member Functions inherited from SequentialTask
	SequentialTask (const char *nm=nullptr)

virtual	~SequentialTask ()

virtual int	doStep ()

bool	execute ()

ProgressMeter *	progressMeter ()

const ProgressMeter *	progressMeter () const

void	setProgressMeter (ProgressMeter *)
	Must be called before execute() More...

Public Member Functions inherited from Task
virtual	~Task ()

virtual void	controlWork (Control)

virtual void	enableWorkControl (bool=true)
	Must be called before execute() More...

virtual uiRetVal	errorWithDetails () const

virtual Control	getState () const

bool	workControlEnabled () const

Public Member Functions inherited from NamedCallBacker
	NamedCallBacker (const char *nm=0)

	NamedCallBacker (const NamedCallBacker &)

virtual Notifier< NamedCallBacker > &	objectToBeDeleted () const

bool	operator== (const NamedCallBacker &oth) const

bool	operator== (const NamedObject &oth) const

Public Member Functions inherited from CallBacker
	CallBacker ()

	CallBacker (const CallBacker &)

virtual	~CallBacker ()

bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const

bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const

void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...

void	detachCB (const NotifierAccess &, const CallBack &) const

void	detachCB (const NotifierAccess *notif, const CallBack &cb) const

virtual bool	isCapsule () const

bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...

void	stopReceivingNotifications () const

Public Member Functions inherited from NamedObject
	NamedObject (const char *nm=nullptr)

	NamedObject (const NamedObject &oth)

virtual	~NamedObject ()

virtual BufferString	getName () const

bool	getNameFromPar (const IOPar &)

virtual const name_type &	name () const

NamedObject &	operator= (const NamedObject &)

bool	operator== (const NamedObject &oth) const

virtual void	setName (const char *nm)

Public Member Functions inherited from ObjectWithName
virtual	~ObjectWithName ()

bool	hasName (const char *nm) const

bool	hasName (const name_type &nm) const

void	putNameInPar (IOPar &) const

Protected Member Functions
int	errorOccured ()

void	setSaveAsPaths (const BufferStringSet &, const char *)

bool	writeData ()

bool	writeDataToBuffer (const char *buffer, int size)

bool	writeDataToFile (const char *buffer, int size)

Protected Member Functions inherited from Task
	Task (const char *nm=nullptr)

virtual bool	shouldContinue ()

Protected Member Functions inherited from NamedCallBacker
void	sendDelNotif () const

Protected Attributes
DataBuffer *	databuffer_

bool	initneeded_

uiString	msg_

od_int64	nrdone_

int	nrfilesdownloaded_

ODNetworkReply *	odnr_

od_ostream *	osd_

QEventLoop *	qeventloop_

BufferStringSet	saveaspaths_

od_int64	totalnr_

BufferStringSet	urls_

Protected Attributes inherited from SequentialTask
int	lastupdate_

ProgressMeter *	progressmeter_

Protected Attributes inherited from Task
Control	control_

Threads::ConditionVar *	workcontrolcondvar_

Protected Attributes inherited from NamedCallBacker
Threads::Atomic< bool >	delalreadytriggered_

Notifier< NamedCallBacker >	delnotif_

Protected Attributes inherited from NamedObject
BufferString	name_

Additional Inherited Members
Public Types inherited from Task
enum	Control { Run , Pause , Stop }

Public Types inherited from ObjectWithName
typedef OD::String	name_type

Static Public Member Functions inherited from SequentialTask
static int	ErrorOccurred ()

static int	Finished ()

static int	MoreToDo ()

static int	WarningAvailable ()

Static Public Member Functions inherited from Task
static uiString	stdNrDoneText ()

static uiString	uiStdNrDoneText ()

Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()

static void	removeReceiverForCurrentThread ()

Detailed Description

>Provides file download facility

<>

Constructor & Destructor Documentation

◆ FileDownloader() [1/3]

FileDownloader::FileDownloader ( const char * url )

◆ FileDownloader() [2/3]

FileDownloader::FileDownloader	(	const char *	url,
		DataBuffer *	db
	)

◆ FileDownloader() [3/3]

FileDownloader::FileDownloader	(	const BufferStringSet &	urls,
		const BufferStringSet &	outputpaths
	)

◆ ~FileDownloader()

FileDownloader::~FileDownloader ( )

Member Function Documentation

◆ errorOccured()

int FileDownloader::errorOccured ( )

protected

◆ getDownloadSize()

od_int64 FileDownloader::getDownloadSize ( )

◆ nextStep()

int FileDownloader::nextStep ( )

virtual

Return values

MoreToDo()	Not finished. Call me again.
Finished()	Nothing more to do.
ErrorOccurred()	Something went wrong.

Note: if function returns a value greater than cMoreToDo(), it should be interpreted as cMoreToDo().

Implements SequentialTask.

◆ nrDone()

od_int64 FileDownloader::nrDone ( ) const

virtual

Note: nrDone is only used for displaying progress and will be compared to totalNr to show user how large part of the task that is finished.

Reimplemented from Task.

◆ setSaveAsPaths()

void FileDownloader::setSaveAsPaths	(	const BufferStringSet &	,
		const char *
	)

protected

◆ totalNr()

od_int64 FileDownloader::totalNr ( ) const

virtual

Reimplemented from Task.

◆ uiMessage()

uiString FileDownloader::uiMessage ( ) const

virtual

will be message() again in 7.x

Reimplemented from Task.

◆ uiNrDoneText()

uiString FileDownloader::uiNrDoneText ( ) const

virtual

will be nrDoneText() in 7.x

Reimplemented from Task.

◆ writeData()

bool FileDownloader::writeData ( )

protected

◆ writeDataToBuffer()

bool FileDownloader::writeDataToBuffer	(	const char *	buffer,
		int	size
	)

protected

◆ writeDataToFile()

bool FileDownloader::writeDataToFile	(	const char *	buffer,
		int	size
	)

protected

Member Data Documentation

◆ databuffer_

DataBuffer* FileDownloader::databuffer_

protected

◆ initneeded_

bool FileDownloader::initneeded_

protected

◆ msg_

uiString FileDownloader::msg_

protected

◆ nrdone_

od_int64 FileDownloader::nrdone_

protected

◆ nrfilesdownloaded_

int FileDownloader::nrfilesdownloaded_

protected

◆ odnr_

ODNetworkReply* FileDownloader::odnr_

protected

◆ osd_

od_ostream* FileDownloader::osd_

protected

◆ qeventloop_

QEventLoop* FileDownloader::qeventloop_

protected

◆ saveaspaths_

BufferStringSet FileDownloader::saveaspaths_

protected

◆ totalnr_

od_int64 FileDownloader::totalnr_

protected

◆ urls_

BufferStringSet FileDownloader::urls_

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FileDownloader() [1/3]

◆ FileDownloader() [2/3]

◆ FileDownloader() [3/3]

◆ ~FileDownloader()

Member Function Documentation

◆ errorOccured()

◆ getDownloadSize()

◆ nextStep()

◆ nrDone()

◆ setSaveAsPaths()

◆ totalNr()

◆ uiMessage()

◆ uiNrDoneText()

◆ writeData()

◆ writeDataToBuffer()

◆ writeDataToFile()

Member Data Documentation

◆ databuffer_

◆ initneeded_

◆ msg_

◆ nrdone_

◆ nrfilesdownloaded_

◆ odnr_

◆ osd_

◆ qeventloop_

◆ saveaspaths_

◆ totalnr_

◆ urls_