Thread-safe singleton management. More...

#include "timemory/utility/singleton.hpp"

Collaboration diagram for tim::singleton< Type, PointerT, TagT >:

Public Types
using	this_type = singleton< Type, PointerT, TagT >

using	thread_id_t = std::thread::id

using	mutex_t = std::recursive_mutex

using	auto_lock_t = std::unique_lock< mutex_t >

using	pointer = Type *

using	children_t = std::set< pointer >

using	smart_pointer = PointerT

using	deleter_t = std::function< void(PointerT &)>

using	dtor_map_t = std::map< pointer, std::function< void()> >

template<bool B, typename T = int>
using	enable_if_t = typename std::enable_if< B, T >::type

Public Member Functions
	singleton ()

	~singleton ()

	singleton (const singleton &)=delete

	singleton (singleton &&)=delete

singleton &	operator= (const singleton &)=delete

singleton &	operator= (singleton &&)=delete

void	initialize ()

void	reset (pointer ptr)

void	reset ()

Static Public Member Functions
static pointer	instance ()

static pointer	master_instance ()

static smart_pointer &	smart_instance ()

static smart_pointer &	smart_master_instance ()

static pointer	instance_ptr ()

static pointer	master_instance_ptr ()

static thread_id_t	master_thread_id ()

static children_t	children ()

static bool	is_master (pointer ptr)

static bool	is_master_thread ()

static void	insert (smart_pointer &itr)

static void	remove (pointer itr)

static mutex_t &	get_mutex ()

Detailed Description

template<typename Type, typename PointerT, typename TagT>
class tim::singleton< Type, PointerT, TagT >

Thread-safe singleton management.

Definition at line 111 of file singleton.hpp.

Member Typedef Documentation

◆ auto_lock_t

template<typename Type , typename PointerT , typename TagT >

using tim::singleton< Type, PointerT, TagT >::auto_lock_t = std::unique_lock<mutex_t>

Definition at line 117 of file singleton.hpp.

◆ children_t

template<typename Type , typename PointerT , typename TagT >

using tim::singleton< Type, PointerT, TagT >::children_t = std::set<pointer>

Definition at line 119 of file singleton.hpp.

◆ deleter_t

template<typename Type , typename PointerT , typename TagT >

using tim::singleton< Type, PointerT, TagT >::deleter_t = std::function<void(PointerT&)>

Definition at line 121 of file singleton.hpp.

◆ dtor_map_t

template<typename Type , typename PointerT , typename TagT >

using tim::singleton< Type, PointerT, TagT >::dtor_map_t = std::map<pointer, std::function<void()> >

Definition at line 122 of file singleton.hpp.

◆ enable_if_t

template<typename Type , typename PointerT , typename TagT >

template<bool B, typename T = int>

using tim::singleton< Type, PointerT, TagT >::enable_if_t = typename std::enable_if<B, T>::type

Definition at line 125 of file singleton.hpp.

◆ mutex_t

template<typename Type , typename PointerT , typename TagT >

using tim::singleton< Type, PointerT, TagT >::mutex_t = std::recursive_mutex

Definition at line 116 of file singleton.hpp.

◆ pointer

template<typename Type , typename PointerT , typename TagT >

using tim::singleton< Type, PointerT, TagT >::pointer = Type*

Definition at line 118 of file singleton.hpp.

◆ smart_pointer

template<typename Type , typename PointerT , typename TagT >

using tim::singleton< Type, PointerT, TagT >::smart_pointer = PointerT

Definition at line 120 of file singleton.hpp.

◆ this_type

template<typename Type , typename PointerT , typename TagT >

using tim::singleton< Type, PointerT, TagT >::this_type = singleton<Type, PointerT, TagT>

Definition at line 114 of file singleton.hpp.

◆ thread_id_t

template<typename Type , typename PointerT , typename TagT >

using tim::singleton< Type, PointerT, TagT >::thread_id_t = std::thread::id

Definition at line 115 of file singleton.hpp.

Constructor & Destructor Documentation

◆ singleton() [1/3]

template<typename Type , typename PointerT , typename TagT >

tim::singleton< Type, PointerT, TagT >::singleton

Definition at line 267 of file singleton.hpp.

{
    initialize();
}

References tim::initialize().

◆ ~singleton()

template<typename Type , typename PointerT , typename TagT >

tim::singleton< Type, PointerT, TagT >::~singleton

Definition at line 275 of file singleton.hpp.

{
    if(std::this_thread::get_id() == f_master_thread())
        f_master_instance() = nullptr;
    auto& del = get_deleter();
    if(del)
        del(_master_instance());
}

◆ singleton() [2/3]

template<typename Type , typename PointerT , typename TagT >

tim::singleton< Type, PointerT, TagT >::singleton ( const singleton< Type, PointerT, TagT > & )

delete

◆ singleton() [3/3]

template<typename Type , typename PointerT , typename TagT >

tim::singleton< Type, PointerT, TagT >::singleton ( singleton< Type, PointerT, TagT > && )

delete

Member Function Documentation

◆ children()

template<typename Type , typename PointerT , typename TagT >

static children_t tim::singleton< Type, PointerT, TagT >::children ( )

inlinestatic

Definition at line 152 of file singleton.hpp.

152{ return f_children(); }

◆ get_mutex()

template<typename Type , typename PointerT , typename TagT >

static mutex_t & tim::singleton< Type, PointerT, TagT >::get_mutex ( )

inlinestatic

Definition at line 157 of file singleton.hpp.

157{ return f_mutex(); }

◆ initialize()

template<typename Type , typename PointerT , typename TagT >

void tim::singleton< Type, PointerT, TagT >::initialize

Definition at line 288 of file singleton.hpp.

{
    if(!f_master_instance())
    {
        f_master_thread()   = std::this_thread::get_id();
        f_master_instance() = new Type{};
    }
}

◆ insert()

template<typename Type , typename PointerT , typename TagT >

void tim::singleton< Type, PointerT, TagT >::insert ( smart_pointer & itr )

static

Definition at line 351 of file singleton.hpp.

{
    auto_lock_t _lk{ f_mutex(), std::defer_lock };
    if(!_lk.owns_lock())
        _lk.lock();
    f_children().insert(itr.get());
    f_dtors().emplace(itr.get(), [&]() { itr.reset(); });
}

◆ instance()

template<typename Type , typename PointerT , typename TagT >

singleton< Type, PointerT, TagT >::pointer tim::singleton< Type, PointerT, TagT >::instance

static

Definition at line 301 of file singleton.hpp.

{
    if(std::this_thread::get_id() == f_master_thread())
    {
        return master_instance();
    }
    if(!_local_instance().get())
    {
        _local_instance().reset(new Type{});
        insert(_local_instance());
    }
    return _local_instance().get();
}

References tim::get().

◆ instance_ptr()

template<typename Type , typename PointerT , typename TagT >

singleton< Type, PointerT, TagT >::pointer tim::singleton< Type, PointerT, TagT >::instance_ptr

static

Definition at line 333 of file singleton.hpp.

{
    return is_master_thread() ? f_master_instance() : _local_instance().get();
}

◆ is_master()

template<typename Type , typename PointerT , typename TagT >

static bool tim::singleton< Type, PointerT, TagT >::is_master ( pointer ptr )

inlinestatic

Definition at line 153 of file singleton.hpp.

153{ return ptr == master_instance_ptr(); }

tim::singleton::master_instance_ptr

static pointer master_instance_ptr()

Definition: singleton.hpp:147

References tim::singleton< Type, PointerT, TagT >::master_instance_ptr().

◆ is_master_thread()

template<typename Type , typename PointerT , typename TagT >

bool tim::singleton< Type, PointerT, TagT >::is_master_thread

static

Definition at line 342 of file singleton.hpp.

{
    return std::this_thread::get_id() == f_master_thread();
}

◆ master_instance()

template<typename Type , typename PointerT , typename TagT >

singleton< Type, PointerT, TagT >::pointer tim::singleton< Type, PointerT, TagT >::master_instance

static

Definition at line 319 of file singleton.hpp.

{
    if(!f_master_instance())
    {
        f_master_thread()   = std::this_thread::get_id();
        f_master_instance() = new Type{};
    }
    return f_master_instance();
}

◆ master_instance_ptr()

template<typename Type , typename PointerT , typename TagT >

static pointer tim::singleton< Type, PointerT, TagT >::master_instance_ptr ( )

inlinestatic

Definition at line 147 of file singleton.hpp.

147{ return f_master_instance(); }

Referenced by tim::singleton< Type, PointerT, TagT >::is_master().

◆ master_thread_id()

template<typename Type , typename PointerT , typename TagT >

static thread_id_t tim::singleton< Type, PointerT, TagT >::master_thread_id ( )

inlinestatic

Definition at line 150 of file singleton.hpp.

150{ return f_master_thread(); }

◆ operator=() [1/2]

template<typename Type , typename PointerT , typename TagT >

singleton & tim::singleton< Type, PointerT, TagT >::operator= ( const singleton< Type, PointerT, TagT > & )

delete

◆ operator=() [2/2]

template<typename Type , typename PointerT , typename TagT >

singleton & tim::singleton< Type, PointerT, TagT >::operator= ( singleton< Type, PointerT, TagT > && )

delete

◆ remove()

template<typename Type , typename PointerT , typename TagT >

void tim::singleton< Type, PointerT, TagT >::remove ( pointer itr )

static

Definition at line 364 of file singleton.hpp.

{
    if(!itr)
        return;
    auto_lock_t _lk{ f_mutex(), std::defer_lock };
    if(!_lk.owns_lock())
        _lk.lock();
    for(auto litr = f_children().begin(); litr != f_children().end(); ++litr)
    {
        if(*litr == itr)
        {
            f_children().erase(litr);
            break;
        }
    }
    auto ditr = f_dtors().find(itr);
    if(ditr != f_dtors().end())
        f_dtors().erase(ditr);
}

◆ reset() [1/2]

template<typename Type , typename PointerT , typename TagT >

void tim::singleton< Type, PointerT, TagT >::reset

Definition at line 423 of file singleton.hpp.

{
    if(_local_instance())
    {
        remove(_local_instance().get());
        _local_instance().reset();
    }
 
    if(is_master_thread())
    {
        if(!f_dtors().empty())
        {
            dtor_map_t _dtors{};
            std::swap(f_dtors(), _dtors);
            for(auto& itr : _dtors)
                itr.second();
        }
 
        if(_master_instance().get())
        {
            _master_instance().reset();
        }
        else if(f_master_instance())
        {
            auto& del = get_deleter();
            del(_master_instance());
            f_master_instance() = nullptr;
        }
    }
    f_persistent_data().reset();
}

References tim::get().

◆ reset() [2/2]

template<typename Type , typename PointerT , typename TagT >

void tim::singleton< Type, PointerT, TagT >::reset ( pointer ptr )

Definition at line 388 of file singleton.hpp.

{
    if(is_master(ptr))
    {
        if(!f_dtors().empty())
        {
            dtor_map_t _dtors{};
            std::swap(f_dtors(), _dtors);
            for(auto& itr : _dtors)
                itr.second();
        }
 
        if(_master_instance().get())
        {
            _master_instance().reset();
        }
        else if(f_master_instance())
        {
            auto& del = get_deleter();
            del(_master_instance());
            f_master_instance() = nullptr;
        }
        f_persistent_data().reset();
    }
    else
    {
        remove(_local_instance().get());
        _local_instance().reset();
    }
}

References tim::get().

◆ smart_instance()

template<typename Type , typename PointerT , typename TagT >

static smart_pointer & tim::singleton< Type, PointerT, TagT >::smart_instance ( )

inlinestatic

Definition at line 142 of file singleton.hpp.

142{ return _local_instance(); }

◆ smart_master_instance()

template<typename Type , typename PointerT , typename TagT >

static smart_pointer & tim::singleton< Type, PointerT, TagT >::smart_master_instance ( )

inlinestatic

Definition at line 143 of file singleton.hpp.

143{ return _master_instance(); }

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

timemory/utility/singleton.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ auto_lock_t

◆ children_t

◆ deleter_t

◆ dtor_map_t

◆ enable_if_t

◆ mutex_t

◆ pointer

◆ smart_pointer

◆ this_type

◆ thread_id_t

Constructor & Destructor Documentation

◆ singleton() [1/3]

◆ ~singleton()

◆ singleton() [2/3]

◆ singleton() [3/3]

Member Function Documentation

◆ children()

◆ get_mutex()

◆ initialize()

◆ insert()

◆ instance()

◆ instance_ptr()

◆ is_master()

◆ is_master_thread()

◆ master_instance()

◆ master_instance_ptr()

◆ master_thread_id()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ remove()

◆ reset() [1/2]

◆ reset() [2/2]

◆ smart_instance()

◆ smart_master_instance()