tracktion::engine::BackgroundJobManager Class Reference

Manages a set of background tasks that can be run concurrently on a background thread. More...

#include "tracktion_BackgroundJobs.h"

Inheritance diagram for tracktion::engine::BackgroundJobManager:

Classes
struct	JobInfo
class	Listener

Public Member Functions
void	addJob (ThreadPoolJobWithProgress *job, bool takeOwnership)
void	removeJob (ThreadPoolJobWithProgress *job, bool interruptIfRunning, int timeOutMilliseconds)
void	stopAndDeleteAllRunningJobs ()
void	signalJobShouldExit (const JobInfo &info)
JobInfo	getJobInfo (int index) const noexcept
int	getNumJobs () const noexcept
float	getTotalProgress () const noexcept
juce::ThreadPool &	getPool () noexcept
void	addListener (Listener *l)
void	removeListener (Listener *l)

Friends
class	ThreadPoolJobWithProgress

Detailed Description

Manages a set of background tasks that can be run concurrently on a background thread.

This is essentially a wrapper around a ThreadPool which adds a listener interface so you can create UI elements to represent the list.

Definition at line 46 of file tracktion_BackgroundJobs.h.

Constructor & Destructor Documentation

BackgroundJobManager()

tracktion::engine::BackgroundJobManager::BackgroundJobManager

(

)

Definition at line 50 of file tracktion_BackgroundJobs.h.

~BackgroundJobManager()

tracktion::engine::BackgroundJobManager::~BackgroundJobManager ( )

override

Definition at line 55 of file tracktion_BackgroundJobs.h.

Member Function Documentation

addJob()

void tracktion::engine::BackgroundJobManager::addJob	(	ThreadPoolJobWithProgress *	job,
		bool	takeOwnership
	)

Definition at line 60 of file tracktion_BackgroundJobs.h.

addListener()

void tracktion::engine::BackgroundJobManager::addListener

(

Listener *

l

)

Definition at line 131 of file tracktion_BackgroundJobs.h.

getJobInfo()

JobInfo tracktion::engine::BackgroundJobManager::getJobInfo ( int  index ) const

noexcept

Definition at line 109 of file tracktion_BackgroundJobs.h.

getNumJobs()

int tracktion::engine::BackgroundJobManager::getNumJobs ( ) const

noexcept

Definition at line 119 of file tracktion_BackgroundJobs.h.

getPool()

juce::ThreadPool & tracktion::engine::BackgroundJobManager::getPool ( )

noexcept

Definition at line 121 of file tracktion_BackgroundJobs.h.

getTotalProgress()

float tracktion::engine::BackgroundJobManager::getTotalProgress ( ) const

noexcept

Definition at line 120 of file tracktion_BackgroundJobs.h.

removeJob()

void tracktion::engine::BackgroundJobManager::removeJob	(	ThreadPoolJobWithProgress *	job,
		bool	interruptIfRunning,
		int	timeOutMilliseconds
	)

Definition at line 69 of file tracktion_BackgroundJobs.h.

removeListener()

void tracktion::engine::BackgroundJobManager::removeListener

(

Listener *

l

)

Definition at line 132 of file tracktion_BackgroundJobs.h.

signalJobShouldExit()

void tracktion::engine::BackgroundJobManager::signalJobShouldExit

(

const JobInfo &

info

)

Definition at line 99 of file tracktion_BackgroundJobs.h.

stopAndDeleteAllRunningJobs()

void tracktion::engine::BackgroundJobManager::stopAndDeleteAllRunningJobs

(

)

Definition at line 74 of file tracktion_BackgroundJobs.h.

Friends And Related Symbol Documentation

ThreadPoolJobWithProgress

friend class ThreadPoolJobWithProgress

friend

Definition at line 145 of file tracktion_BackgroundJobs.h.

---

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

• tracktion_engine/utilities/tracktion_BackgroundJobs.h