Singleton

#include <icy/singleton.h>

template<class S>
class Singleton

Defined in src/base/include/icy/singleton.h:24

Helper template class for managing singleton objects allocated on the heap.

List of all members

Name	Kind	Owner
`Singleton`	`function`	Declared here
`~Singleton`	`function`	Declared here
`get`	`function`	Declared here
`swap`	`function`	Declared here
`destroy`	`function`	Declared here
`_ptr`	`variable`	Declared here
`_m`	`variable`	Declared here

Public Methods

Return	Name	Description
	`Singleton`	Defaulted constructor.
`S *`	`get` `inline`	Returns a pointer to the managed singleton, instantiating it on first call. Thread-safe; protected by an internal mutex.
`S *`	`swap` `inline`	Replaces the managed singleton with newPtr and returns the previous instance. The caller takes ownership of the returned pointer. Thread-safe; protected by an internal mutex.
`void`	`destroy` `inline`	Destroys the managed singleton instance and resets the internal pointer to null. Thread-safe; protected by an internal mutex.

Singleton

Singleton() = default

Defined in src/base/include/icy/singleton.h:27

Defaulted constructor.

get

inline

inline S * get()

Defined in src/base/include/icy/singleton.h:34

Returns a pointer to the managed singleton, instantiating it on first call. Thread-safe; protected by an internal mutex.

Returns

Pointer to the singleton instance (never null).

swap

inline

inline S * swap(S * newPtr)

Defined in src/base/include/icy/singleton.h:47

Replaces the managed singleton with newPtr and returns the previous instance. The caller takes ownership of the returned pointer. Thread-safe; protected by an internal mutex.

Parameters

newPtr Replacement instance (may be nullptr).

Returns

Previously managed pointer (caller must delete if non-null).

destroy

inline

inline void destroy()

Defined in src/base/include/icy/singleton.h:57

Destroys the managed singleton instance and resets the internal pointer to null. Thread-safe; protected by an internal mutex.

Private Attributes

Return	Name	Description
`std::unique_ptr< S, Deleter >`	`_ptr`
`std::mutex`	`_m`

_ptr

std::unique_ptr< S, Deleter > _ptr

Defined in src/base/include/icy/singleton.h:70

_m

std::mutex _m

Defined in src/base/include/icy/singleton.h:71