CLambdaJob< F > Class Template Reference

#include <LambdaJob.h>

Inheritance diagram for CLambdaJob< F >:

Public Member Functions
	CLambdaJob (F function)
	~CLambdaJob () override=default
bool	DoWork () override
	Main workhorse function of CJob instances.
bool	Equals (const CJob *job) const override
	Function that compares this job instance with the given job instance.
Public Member Functions inherited from CJob
	CJob ()=default
virtual	~CJob ()=default
	Destructor for job objects.
virtual const char *	GetType () const
	Function that returns the type of job.
void	SetProgressCallback (CJobManager *callback)
	Function to set a callback for jobs to report progress.
virtual bool	ShouldCancel (unsigned int progress, unsigned int total) const
	Function for longer jobs to report progress and check whether they have been cancelled.

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...

Constructor & Destructor Documentation

CLambdaJob()

template<typename F>

CLambdaJob< F >::CLambdaJob ( F function )

inlineexplicit

~CLambdaJob()

template<typename F>

CLambdaJob< F >::~CLambdaJob ( )

overridedefault

Member Function Documentation

DoWork()

template<typename F>

bool CLambdaJob< F >::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.

Equals()

template<typename F>

bool CLambdaJob< F >::Equals ( const CJob * job ) const

inlineoverridevirtual

Function that compares this job instance with the given job instance.

CJob subclasses may optionally implement this to provide customized comparison functionality. This is useful for the CJobManager::AddJob() routine, which preempts similar jobs with the new job.

Parameters

job	the job to compared with this CJob instance.

Returns

if true, the two jobs are equal.

See also

CJobManager::AddJob()

Reimplemented from CJob.

---

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

• LambdaJob.h