xbmc
Classes | Public Member Functions | List of all members
PVR::CPVREventLogJob Class Reference
Inheritance diagram for PVR::CPVREventLogJob:
Inheritance graph
[legend]
Collaboration diagram for PVR::CPVREventLogJob:
Collaboration graph
[legend]

Public Member Functions

 CPVREventLogJob (bool bNotifyUser, EventLevel eLevel, const std::string &label, const std::string &msg, const std::string &icon)
 
const char * GetType () const override
 Function that returns the type of job. More...
 
void AddEvent (bool bNotifyUser, EventLevel eLevel, const std::string &label, const std::string &msg, const std::string &icon)
 
bool DoWork () override
 Main workhorse function of CJob instances. More...
 
- Public Member Functions inherited from CJob
virtual ~CJob ()=default
 Destructor for job objects. More...
 
virtual bool operator== (const CJob *job) const
 
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 PVR::CPVREventLogJob::DoWork ( )
overridevirtual

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* PVR::CPVREventLogJob::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 files: