G4UA::ThreadActionHolder< ActionType > Class Template Reference

A thread-local storage wrapper for the user actions. More...

#include <ThreadActionHolder.h>

Collaboration diagram for G4UA::ThreadActionHolder< ActionType >:

Public Types
using	ThreadMapKey_t = std::thread::id
using	ThreadMapVal_t = ActionType*
using	ThreadMapHash_t = std::hash<ThreadMapKey_t>
using	ThreadMap_t
using	const_iterator = typename ThreadMap_t::const_iterator

Public Member Functions
	~ThreadActionHolder ()
	Destructor will clean up the thread-local storage.
ActionType *	get ()
	Get the object of the current thread.
void	set (std::unique_ptr< ActionType > action)
	Assign the object of the current thread.
const_iterator	begin () const
	Constant-access iteration over the action map.
const_iterator	end () const
	Constant-access iteration over the action map.

Private Attributes
ThreadMap_t	m_threadMap
	The wrapped thread-local storage container.

Detailed Description

template<class ActionType>
class G4UA::ThreadActionHolder< ActionType >

A thread-local storage wrapper for the user actions.

This container is implemented as a wrapper for a concurrent map keyed by std thread ID. It is thus fully thread-safe (in theory).

The thread-local storage is cleared in the destructor for now, at least until TBB's concurrent containers support move semantics and unique_ptr.

Author

Steve Farrell Steve.nosp@m.n.Fa.nosp@m.rrell.nosp@m.@cer.nosp@m.n.ch

Definition at line 30 of file ThreadActionHolder.h.

Member Typedef Documentation

const_iterator

template<class ActionType>

using G4UA::ThreadActionHolder< ActionType >::const_iterator = typename ThreadMap_t::const_iterator

Definition at line 43 of file ThreadActionHolder.h.

ThreadMap_t

template<class ActionType>

using G4UA::ThreadActionHolder< ActionType >::ThreadMap_t

Initial value:

 tbb::concurrent_unordered_map
                          < ThreadMapKey_t, ThreadMapVal_t, ThreadMapHash_t >

Definition at line 40 of file ThreadActionHolder.h.

ThreadMapHash_t

template<class ActionType>

using G4UA::ThreadActionHolder< ActionType >::ThreadMapHash_t = std::hash<ThreadMapKey_t>

Definition at line 38 of file ThreadActionHolder.h.

ThreadMapKey_t

template<class ActionType>

using G4UA::ThreadActionHolder< ActionType >::ThreadMapKey_t = std::thread::id

Definition at line 35 of file ThreadActionHolder.h.

ThreadMapVal_t

template<class ActionType>

using G4UA::ThreadActionHolder< ActionType >::ThreadMapVal_t = ActionType*

Definition at line 36 of file ThreadActionHolder.h.

Constructor & Destructor Documentation

~ThreadActionHolder()

template<class ActionType>

G4UA::ThreadActionHolder< ActionType >::~ThreadActionHolder ( )

inline

Destructor will clean up the thread-local storage.

Would prefer to do this automatically with unique_ptr.

Definition at line 47 of file ThreadActionHolder.h.

                            {
        for(auto mapPair : m_threadMap){
          delete mapPair.second;
        }
        m_threadMap.clear();
      }

Member Function Documentation

begin()

template<class ActionType>

const_iterator G4UA::ThreadActionHolder< ActionType >::begin ( ) const

inline

Constant-access iteration over the action map.

Definition at line 69 of file ThreadActionHolder.h.

                                   {
        return m_threadMap.begin();
      }

end()

template<class ActionType>

const_iterator G4UA::ThreadActionHolder< ActionType >::end ( ) const

inline

Constant-access iteration over the action map.

Definition at line 74 of file ThreadActionHolder.h.

                                 {
        return m_threadMap.end();
      }

get()

template<class ActionType>

ActionType * G4UA::ThreadActionHolder< ActionType >::get ( )

inline

Get the object of the current thread.

Definition at line 55 of file ThreadActionHolder.h.

                        {
        auto mapPair = m_threadMap.find( std::this_thread::get_id() );
        if(mapPair == m_threadMap.end()) return nullptr;
        return mapPair->second;
      }

set()

template<class ActionType>

void G4UA::ThreadActionHolder< ActionType >::set ( std::unique_ptr< ActionType > action )

inline

Assign the object of the current thread.

Memory management must be handled manually for now.

Definition at line 63 of file ThreadActionHolder.h.

                                                 {
        const auto tid = std::this_thread::get_id();
        m_threadMap.insert( std::make_pair(tid, action.release()) );
      }

Member Data Documentation

m_threadMap

template<class ActionType>

ThreadMap_t G4UA::ThreadActionHolder< ActionType >::m_threadMap

private

The wrapped thread-local storage container.

Definition at line 81 of file ThreadActionHolder.h.

---

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

• ThreadActionHolder.h