ScummVM API documentation
Cloud::FolderDownloadRequest Class Reference
Inheritance diagram for Cloud::FolderDownloadRequest:
Networking::Request GUI::CommandSender

Public Member Functions

 FolderDownloadRequest (Storage *storage, Storage::FileArrayCallback callback, Networking::ErrorCallback ecb, const Common::String &remoteDirectoryPath, const Common::Path &localDirectoryPath, bool recursive)
 
void handle () override
 
void restart () override
 
double getProgress () const
 
uint64 getDownloadedBytes () const
 
uint64 getTotalBytesToDownload () const
 
uint64 getDownloadSpeed () const
 
Common::String getRemotePath () const
 
Common::Path getLocalPath () const
 
- Public Member Functions inherited from Networking::Request
 Request (DataCallback cb, ErrorCallback ecb)
 
virtual void handleRetry ()
 
virtual void pause ()
 
virtual void finish ()
 
virtual void retry (uint32 seconds)
 
RequestState state () const
 
virtual Common::String date () const
 
- Public Member Functions inherited from GUI::CommandSender
 CommandSender (CommandReceiver *target)
 
void setTarget (CommandReceiver *target)
 
CommandReceivergetTarget () const
 
virtual void sendCommand (uint32 cmd, uint32 data)
 

Additional Inherited Members

- Protected Member Functions inherited from Networking::Request
virtual void finishError (const ErrorResponse &error, RequestState state=FINISHED)
 
virtual void finishSuccess ()
 
- Protected Attributes inherited from Networking::Request
DataCallback _callback
 
ErrorCallback _errorCallback
 
RequestState _state
 
uint32 _retryInSeconds
 
- Protected Attributes inherited from GUI::CommandSender
CommandReceiver_target
 

Member Function Documentation

◆ handle()

void Cloud::FolderDownloadRequest::handle ( )
overridevirtual

Method, which does actual work. Depends on what this Request is doing.

Implements Networking::Request.

◆ restart()

void Cloud::FolderDownloadRequest::restart ( )
overridevirtual

Method, which is used to restart the Request.

Implements Networking::Request.

◆ getProgress()

double Cloud::FolderDownloadRequest::getProgress ( ) const

Returns a number in range [0, 1], where 1 is "complete".

◆ getDownloadedBytes()

uint64 Cloud::FolderDownloadRequest::getDownloadedBytes ( ) const

Returns a number of downloaded bytes.

◆ getTotalBytesToDownload()

uint64 Cloud::FolderDownloadRequest::getTotalBytesToDownload ( ) const

Returns a total number of bytes to download.

◆ getDownloadSpeed()

uint64 Cloud::FolderDownloadRequest::getDownloadSpeed ( ) const

Returns average download speed for the last second.

◆ getRemotePath()

Common::String Cloud::FolderDownloadRequest::getRemotePath ( ) const
inline

Returns remote directory path.

◆ getLocalPath()

Common::Path Cloud::FolderDownloadRequest::getLocalPath ( ) const
inline

Returns local directory path.


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