mcloud  1.0.0
MCloud API library for cmcc cloud service
mcloud::api::UploadTask Class Reference

UploadTask is a task item that can be accessed from application layer to fetch basic upload item information, also it's used for content upload by sync manager. More...

#include <uploadtask.h>

+ Inheritance diagram for mcloud::api::UploadTask:
+ Collaboration diagram for mcloud::api::UploadTask:

Public Types

typedef std::shared_ptr< UploadTaskPtr
 
- Public Types inherited from mcloud::api::Task
enum  Status {
  Status::Unstart,
  Status::Running,
  Status::Canceled,
  Status::Paused,
  Status::Broken,
  Status::Complete
}
 The Status enum indicates current status of this task. More...
 
typedef std::function< void(float)> ProgressHandler
 
typedef std::function< void(Status)> StatusHandler
 
typedef std::function< size_t(void *dest, size_t buf_size)> Buffer_Callback
 

Public Member Functions

virtual ~UploadTask ()=default
 
 UploadTask (const UploadTask &)=delete
 
UploadTaskoperator= (const UploadTask &)=delete
 
const std::string & task_id () const override
 Returns an unique id of upload task. More...
 
const std::string & content_id () const override
 Returns an unique id of cloud content on mcloud. More...
 
const std::string & content_name () const override
 Returns a display name of local content. More...
 
const std::string & file_path () const override
 Returns uploaded local content file path. More...
 
const std::string & error_string () const override
 Contains the error string if an error occurs during content uploading. More...
 
const std::string & task_url () const override
 Returns upload url assigned by mcloud for this task. More...
 
Task::Status status () const override
 Returns current sync-up status for this task. More...
 
Task::ProgressHandlerprogress_changed () override
 Handler for upload progress of a task. More...
 
Task::StatusHandlerstatus_changed () override
 Handler for upload status of a task. More...
 
void cancel () override
 cancel the task. More...
 
size_t file_size () const
 Returns file size of upload content. More...
 
bool is_need_upload () const
 Returns true if a uploaded item does not exist in cloud, otherwise return false. More...
 
- Public Member Functions inherited from mcloud::api::Task
virtual ~Task ()=default
 

Friends

class SyncManagerPriv
 

Detailed Description

UploadTask is a task item that can be accessed from application layer to fetch basic upload item information, also it's used for content upload by sync manager.

Definition at line 66 of file uploadtask.h.

Member Typedef Documentation

§ Ptr

typedef std::shared_ptr<UploadTask> mcloud::api::UploadTask::Ptr

Definition at line 68 of file uploadtask.h.

Constructor & Destructor Documentation

§ ~UploadTask()

virtual mcloud::api::UploadTask::~UploadTask ( )
virtualdefault

§ UploadTask()

mcloud::api::UploadTask::UploadTask ( const UploadTask )
delete

Member Function Documentation

§ cancel()

void mcloud::api::UploadTask::cancel ( )
overridevirtual

cancel the task.

See also
Task::StatusHandler

Implements mcloud::api::Task.

§ content_id()

const std::string& mcloud::api::UploadTask::content_id ( ) const
overridevirtual

Returns an unique id of cloud content on mcloud.

Implements mcloud::api::Task.

§ content_name()

const std::string& mcloud::api::UploadTask::content_name ( ) const
overridevirtual

Returns a display name of local content.

Implements mcloud::api::Task.

§ error_string()

const std::string& mcloud::api::UploadTask::error_string ( ) const
overridevirtual

Contains the error string if an error occurs during content uploading.

Implements mcloud::api::Task.

§ file_path()

const std::string& mcloud::api::UploadTask::file_path ( ) const
overridevirtual

Returns uploaded local content file path.

Implements mcloud::api::Task.

§ file_size()

size_t mcloud::api::UploadTask::file_size ( ) const

Returns file size of upload content.

§ is_need_upload()

bool mcloud::api::UploadTask::is_need_upload ( ) const

Returns true if a uploaded item does not exist in cloud, otherwise return false.

§ operator=()

UploadTask& mcloud::api::UploadTask::operator= ( const UploadTask )
delete

§ progress_changed()

Task::ProgressHandler& mcloud::api::UploadTask::progress_changed ( )
overridevirtual

Handler for upload progress of a task.

See also
Task::ProgressHandler

Implements mcloud::api::Task.

§ status()

Task::Status mcloud::api::UploadTask::status ( ) const
overridevirtual

Returns current sync-up status for this task.

Implements mcloud::api::Task.

§ status_changed()

Task::StatusHandler& mcloud::api::UploadTask::status_changed ( )
overridevirtual

Handler for upload status of a task.

See also
Task::StatusHandler

Implements mcloud::api::Task.

§ task_id()

const std::string& mcloud::api::UploadTask::task_id ( ) const
overridevirtual

Returns an unique id of upload task.

Implements mcloud::api::Task.

§ task_url()

const std::string& mcloud::api::UploadTask::task_url ( ) const
overridevirtual

Returns upload url assigned by mcloud for this task.

Note
the url will be expired after a period of time.

Implements mcloud::api::Task.

Friends And Related Function Documentation

§ SyncManagerPriv

friend class SyncManagerPriv
friend

Definition at line 143 of file uploadtask.h.


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