JobScheduler Class Reference

Background job scheduler. More...

#include <cc/build/JobScheduler>

Inheritance diagram for JobScheduler:

Public Member Functions
	JobScheduler (int concurrency)
int	concurrency () const
void	start ()
	Start executing jobs in the background.
void	schedule (const Job &job)
	Schedule job for execution in the background.
void	report (Job &job)
	Report completion of an externally executed job.
bool	collect (Out< Job > finishedJob)
	Collect the next finished job (finishedJob).
int	status () const
	Exit status of the first unsuccessfully finished job, or 0 if all jobs completed successully.
int	totalCount () const
int	finishCount () const
Public Member Functions inherited from Object
	Object ()=default
	Create a null object.
	operator bool () const
	Check if this is a non-null object.
bool	isNull () const
	Check if this is a null object.
int	useCount () const
	Reference count.
template<class T>
bool	is () const
	Check if this object is of type T.
template<class T>
T	as () const
	Cast this object to type T.
bool	isWeak () const
	Check if the underlying object reference is weak.
bool	operator== (const Object &other) const
	Equality operator.
std::strong_ordering	operator<=> (const Object &other) const
	Ordering operator.

Additional Inherited Members
Public Types inherited from Object
using	NullAccess = cc::NullAccess
	Error thrown when trying to access a null object.
using	VirginityTestFailed = cc::VirginityTestFailed
	Error thrown when trying to initialize an object with a non-virgin state.
Protected Member Functions inherited from Object
template<class T>
T	weak () const
template<class T>
void	initOnce ()
	Create the object state when called the first time.
template<class T>
void	initOncePerThread ()
	Create a distinct object state for each thread when called the first time in that thread.
	Object (State *newState)
	Initialize object with newState.
	Object (State *state, Alias)
	Object (State *state, Weak)
Object &	operator= (std::nullptr_t)
Static Protected Member Functions inherited from Object
template<class T>
static T	alias (const State *state)
	Create an alias object for the given state.
template<class T>
static T	weak (const State *state)
Protected Attributes inherited from Object
Handle< State >	me
	Internal object state

Detailed Description

Background job scheduler.

Note

The JobScheduler itself is not meant to be shared between threads

Todo

Establish a clean shutdown logic in case a signal is received (e.g. with a SignalMaster).

Member Function Documentation

start()

void start

(

)

Start executing jobs in the background.

schedule()

void schedule

(

const Job &

job

)

Schedule job for execution in the background.

report()

void report

(

Job &

job

)

Report completion of an externally executed job.

collect()

bool collect

(

Out< Job >

finishedJob

)

Collect the next finished job (finishedJob).

Returns

true if finishedJob is returned otherwise return false (end of operation)

status()

int status

(

)

const

Exit status of the first unsuccessfully finished job, or 0 if all jobs completed successully.