cpp3ds::ThreadLocalPtr< T > Class Template Reference

Pointer to a thread-local variable. More...

#include <ThreadLocalPtr.hpp>

Inheritance diagram for cpp3ds::ThreadLocalPtr< T >:

Public Member Functions
	ThreadLocalPtr (T *value=NULL)
	Default constructor. More...
T &	operator* () const
	Overload of unary operator *. More...
T *	operator-> () const
	Overload of operator -> More...
	operator T * () const
	Cast operator to implicitely convert the pointer to its raw pointer type (T*) More...
ThreadLocalPtr< T > &	operator= (T *value)
	Assignment operator for a raw pointer parameter. More...
ThreadLocalPtr< T > &	operator= (const ThreadLocalPtr< T > &right)
	Assignment operator for a ThreadLocalPtr parameter. More...

Private Member Functions
void	setValue (void *value)
	Set the thread-specific value of the variable. More...
void *	getValue () const
	Retrieve the thread-specific value of the variable. More...

Detailed Description

template<typename T>
class cpp3ds::ThreadLocalPtr< T >

Pointer to a thread-local variable.

cpp3ds::ThreadLocalPtr is a type-safe wrapper for storing pointers to thread-local variables.

A thread-local variable holds a different value for each different thread, unlike normal variable that are shared.

Its usage is completely transparent, so that it is similar to manipulating the raw pointer directly (like any smart pointer).

Usage example:

MyClass object1;
MyClass object2;
cpp3ds::ThreadLocalPtr<MyClass> objectPtr;

void thread1()
{
    objectPtr = &object1; // doesn't impact thread2
    ...
}

void thread2()
{
    objectPtr = &object2; // doesn't impact thread1
    ...
}

int main()
{
    // Create and launch the two threads
    cpp3ds::Thread t1(&thread1);
    cpp3ds::Thread t2(&thread2);
    t1.launch();
    t2.launch();

    return 0;
}

ThreadLocalPtr is designed for internal use; however you can use it if you feel like it fits well your implementation.

Definition at line 41 of file ThreadLocalPtr.hpp.

Constructor & Destructor Documentation

template<typename T>

cpp3ds::ThreadLocalPtr< T >::ThreadLocalPtr

(

T *

value = NULL

)

Default constructor.

Parameters

value

Optional value to initalize the variable

Member Function Documentation

template<typename T>

cpp3ds::ThreadLocalPtr< T >::operator T *

(

)

const

Cast operator to implicitely convert the pointer to its raw pointer type (T*)

Returns

Pointer to the actual object

template<typename T>

T& cpp3ds::ThreadLocalPtr< T >::operator*

(

)

const

Overload of unary operator *.

Like raw pointers, applying the * operator returns a reference to the pointed object.

Returns

Reference to the pointed object

template<typename T>

T* cpp3ds::ThreadLocalPtr< T >::operator->

(

)

const

Overload of operator ->

Like raw pointers, applying the -> operator returns the pointed object.

Returns

Pointed object

template<typename T>

ThreadLocalPtr<T>& cpp3ds::ThreadLocalPtr< T >::operator=

(

T *

value

)

Assignment operator for a raw pointer parameter.

Parameters

value

Pointer to assign

Returns

Reference to self

template<typename T>

ThreadLocalPtr<T>& cpp3ds::ThreadLocalPtr< T >::operator=

(

const ThreadLocalPtr< T > &

right

)

Assignment operator for a ThreadLocalPtr parameter.

Parameters

right

ThreadLocalPtr to assign

Returns

Reference to self

---

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

• ThreadLocalPtr.hpp