Singleton< Type, PointerT > Class Template Reference

Singleton object that allows a deleter class to be specified. More...

Classes
struct	persistent_data

Public Types
using	this_type = Singleton< Type, PointerT >
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	list_t = std::set< pointer >
using	smart_pointer = PointerT
using	deleter_t = std::function< void(PointerT &)>
template<bool B, typename T = int>
using	enable_if_t = typename std::enable_if< B, T >::type

Public Member Functions
	Singleton ()
	Singleton (pointer)
	~Singleton ()
	Singleton (const Singleton &)=delete
	Singleton (Singleton &&)=delete
Singleton &	operator= (const Singleton &)=delete
Singleton &	operator= (Singleton &&)=delete
void	Initialize ()
void	Initialize (pointer)
void	Destroy ()
void	Reset (pointer)
void	Reset ()
void *	operator new (size_t)
void	operator delete (void *ptr)

Static Public Member Functions
static pointer	GetInstance ()
static pointer	GetMasterInstance ()
static thread_id_t	GetMasterThreadID ()
static list_t	Children ()
static bool	IsMaster (pointer ptr)
static bool	IsMasterThread ()
static void	Insert (pointer)
static void	Remove (pointer)
static mutex_t &	GetMutex ()

Protected Member Functions
smart_pointer &	GetSmartInstance ()
pointer	GetRawInstance ()

Static Protected Member Functions
static smart_pointer &	GetSmartMasterInstance ()
static pointer	GetRawMasterInstance ()

Private Member Functions
void *	operator new[] (std::size_t) noexcept
void	operator delete[] (void *) noexcept
template<typename Tp = Type, typename PtrT = PointerT>
deleter_t &	GetDeleter ()
template<typename Tp = Type, typename PtrT = PointerT>
deleter_t &	GetDeleter ()

Static Private Member Functions
static smart_pointer &	_local_instance ()
static smart_pointer &	_master_instance ()
static thread_id_t &	f_master_thread ()
static mutex_t &	f_mutex ()
static pointer &	f_master_instance ()
static list_t &	f_children ()
static persistent_data &	f_persistent_data ()

Private Attributes
bool	m_IsMaster = false

Friends
class	Type

Detailed Description

template<typename Type, typename PointerT = std::unique_ptr<Type, std::default_delete<Type>>>
class PTL::Singleton< Type, PointerT >

Singleton object that allows a deleter class to be specified.

Member Typedef Documentation

using this_type = Singleton<Type, PointerT>

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 list_t = std::set<pointer>

using smart_pointer = PointerT

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

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

Constructor & Destructor Documentation

Singleton

(

)

Singleton

(

pointer

ptr

)

~Singleton

(

)

Singleton ( const Singleton< Type, PointerT > &  )

delete

Singleton ( Singleton< Type, PointerT > &&  )

delete

Member Function Documentation

Singleton& operator= ( const Singleton< Type, PointerT > &  )

delete

Singleton& operator= ( Singleton< Type, PointerT > &&  )

delete

Singleton< Type, PointerT >::pointer GetInstance ( )

static

References JA::Insert().

Singleton< Type, PointerT >::pointer GetMasterInstance ( )

static

static thread_id_t GetMasterThreadID ( )

static

References Singleton< Type, PointerT >::f_master_thread().

static list_t Children ( )

static

References Singleton< Type, PointerT >::f_children().

static bool IsMaster ( pointer  ptr )

static

References Singleton< Type, PointerT >::GetRawMasterInstance().

bool IsMasterThread ( )

static

Referenced by Singleton< Type, PointerT >::GetRawInstance().

void Insert ( pointer  itr )

static

void Remove ( pointer  itr )

static

static mutex_t& GetMutex ( )

static

References Singleton< Type, PointerT >::f_mutex().

void Initialize

(

)

void Initialize

(

pointer

ptr

)

void Destroy

(

)

void Reset

(

pointer

ptr

)

void Reset

(

)

References PTL::Threading::IsMasterThread().

void* operator new

(

size_t

)

void operator delete

(

void *

ptr

)

References Singleton< Type, PointerT >::f_master_instance(), and Singleton< Type, PointerT >::f_master_thread().

smart_pointer& GetSmartInstance ( )

protected

References Singleton< Type, PointerT >::_local_instance().

static smart_pointer& GetSmartMasterInstance ( )

staticprotected

References Singleton< Type, PointerT >::_master_instance().

pointer GetRawInstance ( )

protected

References Singleton< Type, PointerT >::_local_instance(), Singleton< Type, PointerT >::f_master_instance(), and Singleton< Type, PointerT >::IsMasterThread().

static pointer GetRawMasterInstance ( )

staticprotected

References Singleton< Type, PointerT >::f_master_instance().

Referenced by Singleton< Type, PointerT >::IsMaster().

static smart_pointer& _local_instance ( )

staticprivate

Referenced by Singleton< Type, PointerT >::GetRawInstance(), and Singleton< Type, PointerT >::GetSmartInstance().

static smart_pointer& _master_instance ( )

staticprivate

Referenced by Singleton< Type, PointerT >::GetSmartMasterInstance().

void* operator new[] ( std::size_t  )

privatenoexcept

void operator delete[] ( void *  )

privatenoexcept

deleter_t& GetDeleter ( )

private

deleter_t& GetDeleter ( )

private

Singleton< Type, PointerT >::thread_id_t & f_master_thread ( )

staticprivate

Referenced by Singleton< Type, PointerT >::GetMasterThreadID(), and Singleton< Type, PointerT >::operator delete().

Singleton< Type, PointerT >::mutex_t & f_mutex ( )

staticprivate

Referenced by Singleton< Type, PointerT >::GetMutex().

Singleton< Type, PointerT >::pointer & f_master_instance ( )

staticprivate

Referenced by Singleton< Type, PointerT >::GetRawInstance(), Singleton< Type, PointerT >::GetRawMasterInstance(), and Singleton< Type, PointerT >::operator delete().

Singleton< Type, PointerT >::list_t & f_children ( )

staticprivate

Referenced by Singleton< Type, PointerT >::Children().

static persistent_data& f_persistent_data ( )

staticprivate

Friends And Related Function Documentation

friend class Type

friend

Member Data Documentation

bool m_IsMaster = false

private