VizKit::VisualThreadingManager Class Reference

#include <VisualThreadingManager.h>

List of all members.

Classes
struct	ThreadItem
Public Types
enum	VisualCriticalRegion {   downloadQueueSingletonMutex = 0, downloadQueueAccessMutex = 1, addRequestDownloadQueueAccess = 2, stopRequestDownloadQueueAccess = 3,   notificationQueueSingletonMutex = 4, notificationQueueAccessMutex = 5, inputNotificationQueueAccessMutex = 6, timeStoreSingletonMutex = 7,   timeStoreAccessMutex = 8, currentTimeAccessMutex = 9, appProcAccessMutex = 10, appCookieAccessMutex = 11,   appVersionAccessMutex = 12, visualizerAPIVersionAccessMutex = 13, trackPlayPositionAccessMutex = 14, audioDataTimestampIDAccessMutex = 15,   audioMetaDataAccessMutex = 16, audioMetaDataHistoryIndexAccessMutex = 17, visualItemIdentifierAccessMutex = 18 }
Static Public Member Functions
static void	dispose (void)
static bool	createThread (ThreadingFuncPtr aThreadingFuncPtr, void *param=NULL, VisualThreading::ThreadDidDieCallback callbackAfterThreadDidDie=NULL)
static size_t	getNumberOfCurrentlyRunningThreads (void)
static void	update (void)
static void	enterCriticalSection (VisualCriticalRegion aCriticalSection)
static void	exitCriticalSection (VisualCriticalRegion aCriticalSection)
Private Types
typedef std::vector< ThreadItem >	ThreadVector
typedef ThreadVector::iterator	ThreadVectorIterator
Private Member Functions
	VisualThreadingManager ()
	~VisualThreadingManager ()
	VisualThreadingManager (const VisualThreadingManager &other)
VisualThreadingManager &	operator= (const VisualThreadingManager &other)
Static Private Member Functions
static VisualThreadingManager *	getInstance (void)
Private Attributes
ThreadVector	threadVector
volatile bool	terminateAllThreads
Static Private Attributes
static VisualThreadingManager *	theVisualThreadingManager = NULL

---

Detailed Description

VisualThreadingManager holds identifiers for currently running threads.

---

Member Typedef Documentation

typedef std::vector<ThreadItem> VizKit::VisualThreadingManager::ThreadVector [private]

An ThreadVector is a vector of running threads.

typedef ThreadVector::iterator VizKit::VisualThreadingManager::ThreadVectorIterator [private]

An ThreadVectorIterator is an iterator of a ThreadVector.

---

Member Enumeration Documentation

enum VizKit::VisualThreadingManager::VisualCriticalRegion

Identifiers of critical regions in VizKit.

Enumerator:

downloadQueueSingletonMutex	VisualDownloadQueue initialization.
downloadQueueAccessMutex	VisualDownloadQueue access or iteration.
addRequestDownloadQueueAccess	Add to download queue.
stopRequestDownloadQueueAccess	Remove from download queue.
notificationQueueSingletonMutex	VisualNotificationQueue initialization.
notificationQueueAccessMutex	VisualNotificationQueue access or iteration.
inputNotificationQueueAccessMutex	VisualNotificationQueue access or iteration.
timeStoreSingletonMutex	Initialization of VisualTiming.
timeStoreAccessMutex	Access of or iteration over internal map of VisualTiming.
currentTimeAccessMutex	Access of VisualTiming's currentTime variable.
appProcAccessMutex	Access of app proc.
appCookieAccessMutex	Access of app cookie.
appVersionAccessMutex	Access of app version.
visualizerAPIVersionAccessMutex	Access of visualizer API version.
trackPlayPositionAccessMutex	Access of track play position.
audioDataTimestampIDAccessMutex	Access of audio data timestamp id.
audioMetaDataAccessMutex	Access of audio meta data.
audioMetaDataHistoryIndexAccessMutex	Access of audio meta data history index.
visualItemIdentifierAccessMutex	Access of visual item identifier.

---

Constructor & Destructor Documentation

VisualThreadingManager::VisualThreadingManager

(

)

[private]

The constructor. VisualThreadingManager is a singleton class. The constructor is private. New instance of class can only be created internally.

VisualThreadingManager::~VisualThreadingManager

(

)

[private]

The destructor. VisualThreadingManager is a singleton class. The destructor is private. Instance of class can only be destructed internally.

VizKit::VisualThreadingManager::VisualThreadingManager

(

const VisualThreadingManager &

other

)

[private]

Copy constructor.

Parameters:

other

Another VisualNetwork.

Remarks:

Explicitely declared in private section and not implemented to enforce uniqueness of singleton pattern.

---

Member Function Documentation

bool VisualThreadingManager::createThread	(	ThreadingFuncPtr	aThreadingFuncPtr,
		void *	param = NULL,
		VisualThreading::ThreadDidDieCallback	callbackAfterThreadDidDie = NULL
	)		[static]

Creates a new thread by calling task function.

Parameters:

aThreadingFuncPtr	Pointer to function that should be started in new thread.
param	Optional name for function-thread. Useful for debugging purposes.
callbackAfterThreadDidDie	Callback that is called after the created thread did finished execution.

Returns:

True on success, false on failure.

void VisualThreadingManager::dispose

(

void

)

[static]

Disposes the VisualThreadingManager.

void VisualThreadingManager::enterCriticalSection

(

VisualCriticalRegion

aCriticalSection

)

[static]

Entering a critical section.

Parameters:

aCriticalSection

Identifier of critical section / critical region.

void VisualThreadingManager::exitCriticalSection

(

VisualCriticalRegion

aCriticalSection

)

[static]

Exiting a critical section.

Parameters:

aCriticalSection

Identifier of critical section / critical region.

VisualThreadingManager * VisualThreadingManager::getInstance

(

void

)

[static, private]

Constructs a VisualThreadingManager. The VisualThreadingManager acts as a singleton. Returns a pointer to the initialised VisualThreadingManager.

Returns:

A pointer to the singleton instance.

size_t VisualThreadingManager::getNumberOfCurrentlyRunningThreads

(

void

)

[static]

Returns the number of currently running threads.

Returns:

The number of currently running threads.

VisualThreadingManager& VizKit::VisualThreadingManager::operator=

(

const VisualThreadingManager &

other

)

[private]

Assignment operator.

Remarks:

Explicitely declared in private section and not implemented to enforce uniqueness of singleton pattern.

void VisualThreadingManager::update

(

void

)

[static]

Updates the current internal statistics by asking for the status of registered threads.

---

Member Data Documentation

volatile bool VizKit::VisualThreadingManager::terminateAllThreads [private]

Signal to stop all threads.

VisualThreadingManager * VisualThreadingManager::theVisualThreadingManager = NULL [static, private]

VisualThreadingManager is a singleton class. Pointer to private instance is handled internally.

ThreadVector VizKit::VisualThreadingManager::threadVector [private]

The vector with the running threads.

---

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

• source/Tools/VisualThreadingManager.h
• source/Tools/VisualThreadingManager.cpp