kodi
Public Member Functions | List of all members
CDirectoryJob Class Reference
Inheritance diagram for CDirectoryJob:
Inheritance graph
[legend]
Collaboration diagram for CDirectoryJob:
Collaboration graph
[legend]

Public Member Functions

 CDirectoryJob (const std::string &url, const std::string &target, SortDescription sort, int limit, CDirectoryProvider::BrowseMode browse, int parentID)
 
const char * GetType () const override
 Function that returns the type of job. More...
 
bool operator== (const CJob *job) const override
 
bool DoWork () override
 Main workhorse function of CJob instances. More...
 
std::shared_ptr< CThumbLoadergetThumbLoader (const CGUIStaticItemPtr &item)
 
template<class CThumbLoaderClass >
void initThumbLoader (InfoTagType type)
 
const std::vector< CGUIStaticItemPtr > & GetItems () const
 
const std::string & GetTarget () const
 
std::vector< InfoTagType > GetItemTypes (std::vector< InfoTagType > &itemTypes) const
 
- Public Member Functions inherited from CJob
virtual ~CJob ()=default
 Destructor for job objects. More...
 
virtual bool ShouldCancel (unsigned int progress, unsigned int total) const
 Function for longer jobs to report progress and check whether they have been cancelled. More...
 

Additional Inherited Members

- Public Types inherited from CJob
enum  PRIORITY {
  PRIORITY_LOW_PAUSABLE = 0, PRIORITY_LOW, PRIORITY_NORMAL, PRIORITY_HIGH,
  PRIORITY_DEDICATED
}
 Priority levels for jobs, specified by clients when adding jobs to the CJobManager. More...
 

Member Function Documentation

◆ DoWork()

bool CDirectoryJob::DoWork ( )
inlineoverridevirtual

Main workhorse function of CJob instances.

All CJob subclasses must implement this function, performing all processing. Once this function is complete, the OnJobComplete() callback is called, and the job is then destroyed.

See also
CJobManager, IJobCallback::OnJobComplete()

Implements CJob.

◆ GetType()

const char* CDirectoryJob::GetType ( ) const
inlineoverridevirtual

Function that returns the type of job.

CJob subclasses may optionally implement this function to specify the type of job. This is useful for the CJobManager::AddLIFOJob() routine, which preempts similar jobs with the new job.

Returns
a unique character string describing the job.
See also
CJobManager

Reimplemented from CJob.


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