DataUploader Class Reference

>Provides file or data upload facility More...

Inheritance diagram for DataUploader:

Public Member Functions
	DataUploader (const char *url, const DataBuffer &data, BufferString &header)
	~DataUploader ()
int	nextStep () override
od_int64	nrDone () const override
od_int64	totalNr () const override
uiString	uiMessage () const override
	will be message() again in 7.x More...
uiString	uiNrDoneText () const override
	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 () override
Public Member Functions inherited from ReportingTask
virtual	~ReportingTask ()
void	getProgress (const ReportingTask &)
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
virtual CallBacker *	trueCaller ()
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 &)
const name_type &	name () const override
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 ()
Protected Member Functions inherited from ReportingTask
	ReportingTask (const char *nm=nullptr)
void	incrementProgress ()
ProgressMeter *	progressMeter () const
void	reportProgressFinished ()
void	reportProgressStarted ()
void	resetProgress ()
void	setProgressMeter (ProgressMeter *) override
	Must be called before execute() More...
void	updateProgressMeter (bool forced=false, std::int64_t *totalnr=0)
void	updateReportedName ()
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
const DataBuffer &	data_
BufferString	header_
bool	init_ = true
uiString	msg_
od_int64	nrdone_ = 0
RefMan< Network::HttpRequestProcess >	odnr_
od_int64	totalnr_ = 0
BufferString	url_
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 ()
Public Attributes inherited from ReportingTask
Notifier< ReportingTask >	progressUpdated

Detailed Description

>Provides file or data upload facility

<>

Constructor & Destructor Documentation

DataUploader()

DataUploader::DataUploader	(	const char *	url,
		const DataBuffer &	data,
		BufferString &	header
	)

~DataUploader()

DataUploader::~DataUploader

(

)

Member Function Documentation

errorOccured()

int DataUploader::errorOccured ( )

protected

nextStep()

int DataUploader::nextStep ( )

overridevirtual

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 DataUploader::nrDone ( ) const

overridevirtual

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.

totalNr()

od_int64 DataUploader::totalNr ( ) const

overridevirtual

Reimplemented from Task.

uiMessage()

uiString DataUploader::uiMessage ( ) const

overridevirtual

will be message() again in 7.x

Reimplemented from Task.

uiNrDoneText()

uiString DataUploader::uiNrDoneText ( ) const

overridevirtual

will be nrDoneText() in 7.x

Reimplemented from Task.

Member Data Documentation

data_

const DataBuffer& DataUploader::data_

protected

header_

BufferString DataUploader::header_

protected

init_

bool DataUploader::init_ = true

protected

msg_

uiString DataUploader::msg_

protected

nrdone_

od_int64 DataUploader::nrdone_ = 0

protected

odnr_

RefMan<Network::HttpRequestProcess> DataUploader::odnr_

protected

totalnr_

od_int64 DataUploader::totalnr_ = 0

protected

url_

BufferString DataUploader::url_

protected