Basic class: task and memory management, any kind of static data. More...

#include <context.h>

Inheritance diagram for Beatmup::Context:

Classes
class	EventListener
	An event listener (bunch of callbacks) More...

class	Impl
	Context class implementation (pimpl) More...

Public Member Functions
	Context ()

	Context (const PoolIndex numThreadPools)

	~Context ()

float	performTask (AbstractTask &task, const PoolIndex pool=DEFAULT_POOL)
	Performs a given task. More...

void	repeatTask (AbstractTask &task, bool abortCurrent, const PoolIndex pool=DEFAULT_POOL)
	Ensures a given task executed at least once. More...

Job	submitTask (AbstractTask &task, const PoolIndex pool=DEFAULT_POOL)
	Adds a new task to the jobs queue. More...

Job	submitPersistentTask (AbstractTask &task, const PoolIndex pool=DEFAULT_POOL)
	Adds a new persistent task to the jobs queue. More...

void	waitForJob (Job job, const PoolIndex pool=DEFAULT_POOL)
	Waits until a given job finishes. More...

bool	abortJob (Job job, const PoolIndex pool=DEFAULT_POOL)
	Aborts a given submitted job. More...

void	wait (const PoolIndex pool=DEFAULT_POOL)
	Blocks until all the submitted jobs are executed. More...

bool	busy (const PoolIndex pool=DEFAULT_POOL)
	Queries whether a given thread pool is busy with a task. More...

void	check (const PoolIndex pool=DEFAULT_POOL)
	Checks if a specific thread pool is doing great: rethrows exceptions occurred during tasks execution, if any. More...

const ThreadIndex	maxAllowedWorkerCount (const PoolIndex pool=DEFAULT_POOL) const

void	limitWorkerCount (ThreadIndex maxValue, const PoolIndex pool=DEFAULT_POOL)
	Limits maximum number of threads (workers) when performing tasks in a given pool. More...

void	setEventListener (EventListener *eventListener)
	Installs new event listener. More...

EventListener *	getEventListener () const
	Returns current event listener (or NULL) More...

bool	isGpuQueried () const

bool	isGpuReady () const

void	warmUpGpu ()
	Initializes GPU within a given Context if not yet (takes no effect if it already is). More...

bool	queryGpuInfo (std::string &vendor, std::string &renderer)
	Initializes the GPU if not yet and queries information about it. More...

bool	isManagingThread () const

GL::RecycleBin *	getGpuRecycleBin () const

bool	operator== (const Context &context) const
	Context comparaison operator Two different instances of contexts are basically never identical; returning `true` only if the two point to the same instance. More...

Public Member Functions inherited from Beatmup::Object
virtual	~Object ()

Static Public Attributes
static const PoolIndex	DEFAULT_POOL = 0

Private Member Functions
	Context (const Context &)=delete
	disabling copying constructor More...

Private Attributes
Impl *	impl

GL::RecycleBin *	recycleBin
	stores GPU garbage: resources managed by GPU and might be freed in the managing thread only More...

Detailed Description

Basic class: task and memory management, any kind of static data.

Definition at line 59 of file context.h.

Constructor & Destructor Documentation

◆ Context() [1/3]

Beatmup::Context::Context ( const Context & )

privatedelete

disabling copying constructor

◆ Context() [2/3]

Context::Context ( )

Definition at line 226 of file context.cpp.

226 : Context(1) {}

Beatmup::Context::Context

Context()

Definition: context.cpp:226

◆ Context() [3/3]

Context::Context ( const PoolIndex numThreadPools )

Definition at line 227 of file context.cpp.

                                                {
     impl = new Impl(numThreadPools);
     recycleBin = new GL::RecycleBin(*this);
 }

◆ ~Context()

Context::~Context ( )

Definition at line 233 of file context.cpp.

                   {
     if (recycleBin)
         recycleBin->emptyBin();
     delete recycleBin;
     delete impl;
 }

Member Function Documentation

◆ performTask()

float Context::performTask	(	AbstractTask &	task,
		const PoolIndex	pool = `DEFAULT_POOL`
	)

Performs a given task.

Parameters

task	The task
pool	A thread pool to run the task in

Returns: task execution time

Definition at line 240 of file context.cpp.

                                                                    {
     return impl->performTask(pool, task);
 }

◆ repeatTask()

void Context::repeatTask	(	AbstractTask &	task,
		bool	abortCurrent,
		const PoolIndex	pool = `DEFAULT_POOL`
	)

Ensures a given task executed at least once.

Parameters

task	The task
abortCurrent	if `true` and the same task is currently running, the abort signal is sent.
pool	A thread pool to run the task in

Definition at line 244 of file context.cpp.

                                                                                     {
     return impl->repeatTask(pool, task, abortCurrent);
 }

◆ submitTask()

Job Context::submitTask	(	AbstractTask &	task,
		const PoolIndex	pool = `DEFAULT_POOL`
	)

Adds a new task to the jobs queue.

Parameters

task	The task
pool	A thread pool to run the task in

Definition at line 248 of file context.cpp.

                                                                 {
     return impl->submitTask(pool, task);
 }

◆ submitPersistentTask()

Job Context::submitPersistentTask	(	AbstractTask &	task,
		const PoolIndex	pool = `DEFAULT_POOL`
	)

Adds a new persistent task to the jobs queue.

Persistent task is repeated until it decides itself to quit.

Parameters

task	The task
pool	A thread pool to run the task in

Definition at line 252 of file context.cpp.

                                                                           {
     return impl->submitPersistentTask(pool, task);
 }

◆ waitForJob()

void Context::waitForJob	(	Job	job,
		const PoolIndex	pool = `DEFAULT_POOL`
	)

Waits until a given job finishes.

Parameters

job	The job
pool	Pool index

Definition at line 256 of file context.cpp.

                                                       {
     impl->waitForJob(pool, job);
 }

◆ abortJob()

bool Context::abortJob	(	Job	job,
		const PoolIndex	pool = `DEFAULT_POOL`
	)

Aborts a given submitted job.

Parameters

job	The job
pool	Pool index

Returns: true if the job was interrupted while running.

Definition at line 260 of file context.cpp.

                                                     {
     return impl->abortJob(pool, job);
 }

◆ wait()

void Context::wait ( const PoolIndex pool = DEFAULT_POOL )

Blocks until all the submitted jobs are executed.

Parameters

pool	Pool index

Definition at line 264 of file context.cpp.

                                        {
     impl->wait(pool);
 }

◆ busy()

bool Context::busy ( const PoolIndex pool = DEFAULT_POOL )

Queries whether a given thread pool is busy with a task.

Parameters

pool	The thread pool to query

Returns: true if the thread pool is running a task, false otherwise

Definition at line 268 of file context.cpp.

                                        {
     return impl->busy(pool);
 }

◆ check()

void Context::check ( const PoolIndex pool = DEFAULT_POOL )

Checks if a specific thread pool is doing great: rethrows exceptions occurred during tasks execution, if any.

Parameters

pool	The thread pool to query

Definition at line 272 of file context.cpp.

                                         {
     impl->check(pool);
 }

◆ maxAllowedWorkerCount()

const ThreadIndex Context::maxAllowedWorkerCount ( const PoolIndex pool = DEFAULT_POOL ) const

Returns: maximum number of working threads per task in a given pool.

Definition at line 276 of file context.cpp.

                                                                            {
     return impl->maxAllowedWorkerCount(pool);
 }

◆ limitWorkerCount()

void Context::limitWorkerCount	(	ThreadIndex	maxValue,
		const PoolIndex	pool = `DEFAULT_POOL`
	)

Limits maximum number of threads (workers) when performing tasks in a given pool.

Parameters

maxValue	Number limiting the worker count
pool	The thread pool

Returns: new maximum limit.

Definition at line 280 of file context.cpp.

                                                                          {
     impl->limitWorkerCount(pool, maxValue);
 }

◆ setEventListener()

void Context::setEventListener ( EventListener * eventListener )

Installs new event listener.

Definition at line 284 of file context.cpp.

                                                            {
     impl->eventListener = eventListener;
 }

◆ getEventListener()

Context::EventListener * Context::getEventListener ( ) const

Returns current event listener (or NULL)

Definition at line 288 of file context.cpp.

                                                       {
     return impl->eventListener;
 }

◆ isGpuQueried()

bool Context::isGpuQueried ( ) const

Returns: true if GPU was queried

Definition at line 292 of file context.cpp.

                                  {
     return impl->isGpuQueried();
 }

◆ isGpuReady()

bool Context::isGpuReady ( ) const

Returns: true if GPU was queried and ready to use

Definition at line 296 of file context.cpp.

                                {
     return impl->isGpuReady();
 }

◆ warmUpGpu()

void Context::warmUpGpu ( )

Initializes GPU within a given Context if not yet (takes no effect if it already is).

GPU initialization may take some time and is done when a first task using GPU is being run. Warming up the GPU is useful to avoid the app get stucked for some time when it launches its first task on GPU.

Definition at line 300 of file context.cpp.

                         {
     if (!isGpuReady()) {
         GpuTask task;
         performTask(task);
     }
 }

◆ queryGpuInfo()

bool Context::queryGpuInfo	(	std::string &	vendor,
		std::string &	renderer
	)

Initializes the GPU if not yet and queries information about it.

Parameters

[out]	vendor	GPU vendor string.
[out]	renderer	renderer string.

Returns: true if a GPU is found.

Definition at line 307 of file context.cpp.

                                                                  {
     class GpuQueryingTask : public AbstractTask {
     public:
         bool gpuFound;
         std::string &vendor, &renderer;
  
         GpuQueryingTask(std::string& vendor, std::string& renderer) :
             vendor(vendor), renderer(renderer) {}
  
         TaskDeviceRequirement getUsedDevices() const { return TaskDeviceRequirement::GPU_OR_CPU; }
  
         bool process(TaskThread& thread) {
             gpuFound = false;
             return true;
         }
  
         bool processOnGPU(GraphicPipeline& gpu, TaskThread& thread) {
             vendor = gpu.getGpuVendorString();
             renderer = gpu.getGpuRendererString();
             gpuFound = true;
             return true;
         }
     } task(vendor, renderer);
  
     performTask(task);
  
     return task.gpuFound;
 }

◆ isManagingThread()

bool Context::isManagingThread ( ) const

Definition at line 336 of file context.cpp.

                                      {
     return impl->isManagingThread();
 }

◆ getGpuRecycleBin()

GL::RecycleBin * Context::getGpuRecycleBin ( ) const

Returns: GPU recycle bin to store GPU resources that can be freed only within a GPU-aware thread

Definition at line 340 of file context.cpp.

                                               {
     return recycleBin;
 }

◆ operator==()

bool Beatmup::Context::operator== ( const Context & context ) const

inline

Context comparaison operator Two different instances of contexts are basically never identical; returning true only if the two point to the same instance.

Definition at line 244 of file context.h.

                                                              {
             return this == &context;
         }

Member Data Documentation

◆ impl

Impl* Beatmup::Context::impl

private

Definition at line 63 of file context.h.

◆ recycleBin

GL::RecycleBin* Beatmup::Context::recycleBin

private

stores GPU garbage: resources managed by GPU and might be freed in the managing thread only

Definition at line 64 of file context.h.

◆ DEFAULT_POOL

const PoolIndex Beatmup::Context::DEFAULT_POOL = 0

static

Definition at line 67 of file context.h.

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

core/context.h
core/context.cpp

Classes

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Context() [1/3]

◆ Context() [2/3]

◆ Context() [3/3]

◆ ~Context()

Member Function Documentation

◆ performTask()

◆ repeatTask()

◆ submitTask()

◆ submitPersistentTask()

◆ waitForJob()

◆ abortJob()

◆ wait()

◆ busy()

◆ check()

◆ maxAllowedWorkerCount()

◆ limitWorkerCount()

◆ setEventListener()

◆ getEventListener()

◆ isGpuQueried()

◆ isGpuReady()

◆ warmUpGpu()

◆ queryGpuInfo()

◆ isManagingThread()

◆ getGpuRecycleBin()

◆ operator==()

Member Data Documentation

◆ impl

◆ recycleBin

◆ DEFAULT_POOL