ThreadLocalValue< Type > Class Template Reference

Provides cross-platform support for thread-local objects. More...

#include <juce_ThreadLocalValue.h>

Collaboration diagram for ThreadLocalValue< Type >:

Classes
struct	ObjectHolder

Public Member Functions
	ThreadLocalValue () noexcept
	~ThreadLocalValue ()
	Destructor. More...
Type &	get () const noexcept
	Returns a reference to this thread's instance of the value. More...
	operator Type * () const noexcept
	Returns a pointer to this thread's instance of the value. More...
Type &	operator* () const noexcept
	Returns a reference to this thread's instance of the value. More...
Type *	operator-> () const noexcept
	Accesses a method or field of the value object. More...
ThreadLocalValue &	operator= (const Type &newValue)
	Assigns a new value to the thread-local object. More...
void	releaseCurrentThreadStorage ()
	Called by a thread before it terminates, to allow this class to release any storage associated with the thread. More...

Private Attributes
Atomic< ObjectHolder * >	first

Detailed Description

template<typename Type>
class ThreadLocalValue< Type >

Provides cross-platform support for thread-local objects.

This class holds an internal list of objects of the templated type, keeping an instance for each thread that requests one. The first time a thread attempts to access its value, an object is created and added to the list for that thread.

Typically, you'll probably want to create a static instance of a ThreadLocalValue object, or hold one within a singleton.

The templated class for your value must be a primitive type, or a simple POD struct.

When a thread no longer needs to use its value, it can call releaseCurrentThreadStorage() to allow the storage to be re-used by another thread. If a thread exits without calling this method, the object storage will be left allocated until the ThreadLocalValue object is deleted.

Constructor & Destructor Documentation

ThreadLocalValue()

template<typename Type >

ThreadLocalValue< Type >::ThreadLocalValue ( )

inlinenoexcept

~ThreadLocalValue()

template<typename Type >

ThreadLocalValue< Type >::~ThreadLocalValue ( )

inline

Destructor.

When this object is deleted, all the value objects for all threads will be deleted.

References ThreadLocalValue< Type >::first.

Member Function Documentation

get()

template<typename Type >

Type& ThreadLocalValue< Type >::get ( ) const

inlinenoexcept

Returns a reference to this thread's instance of the value.

Note that the first time a thread tries to access the value, an instance of the value object will be created - so if your value's class has a non-trivial constructor, be aware that this method could invoke it.

References Atomic< Type >::compareAndSetBool(), ThreadLocalValue< Type >::first, Atomic< Type >::get(), Thread::getCurrentThreadId(), ThreadLocalValue< Type >::ObjectHolder::next, ThreadLocalValue< Type >::ObjectHolder::object, and ThreadLocalValue< Type >::ObjectHolder::threadId.

operator Type *()

template<typename Type >

ThreadLocalValue< Type >::operator Type * ( ) const

inlinenoexcept

Returns a pointer to this thread's instance of the value.

Note that the first time a thread tries to access the value, an instance of the value object will be created - so if your value's class has a non-trivial constructor, be aware that this method could invoke it.

operator*()

template<typename Type >

Type& ThreadLocalValue< Type >::operator* ( ) const

inlinenoexcept

Returns a reference to this thread's instance of the value.

Note that the first time a thread tries to access the value, an instance of the value object will be created - so if your value's class has a non-trivial constructor, be aware that this method could invoke it.

operator->()

template<typename Type >

Type* ThreadLocalValue< Type >::operator-> ( ) const

inlinenoexcept

Accesses a method or field of the value object.

Note that the first time a thread tries to access the value, an instance of the value object will be created - so if your value's class has a non-trivial constructor, be aware that this method could invoke it.

operator=()

template<typename Type >

ThreadLocalValue& ThreadLocalValue< Type >::operator= ( const Type &  newValue )

inline

Assigns a new value to the thread-local object.

releaseCurrentThreadStorage()

template<typename Type >

void ThreadLocalValue< Type >::releaseCurrentThreadStorage ( )

inline

Called by a thread before it terminates, to allow this class to release any storage associated with the thread.

References ThreadLocalValue< Type >::first, and Thread::getCurrentThreadId().

Member Data Documentation

first

template<typename Type >

Atomic<ObjectHolder*> ThreadLocalValue< Type >::first

mutableprivate

Referenced by ThreadLocalValue< Type >::get(), ThreadLocalValue< Type >::releaseCurrentThreadStorage(), and ThreadLocalValue< Type >::~ThreadLocalValue().

---

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

• juce_ThreadLocalValue.h