CoreComponents 4.0.0
A Modern C++ Toolkit
Loading...
Searching...
No Matches
Singleton Class Reference

Process-wide singletons More...

#include <cc/Singleton>

Inheritance diagram for Singleton:

Protected Member Functions

 Singleton ()=default
 Create a null singleton.
 
 Singleton (State *state)
 Initialize singleton object with instance state.
 
- Protected Member Functions inherited from Object
template<class T >
weak () const
 
template<class T >
void initOnce ()
 Create the object state when called the first time.
 
template<class T >
void initOncePerThread ()
 Create a distinct object state for each thread when called the first time in that thread.
 
 Object (State *newState)
 Initialize object with newState.
 
 Object (State *state, Alias)
 
 Object (State *state, Weak)
 
Objectoperator= (std::nullptr_t)
 

Static Protected Member Functions

template<class T >
static Handle< T > & handle ()
 
template<class T >
static void destroy ()
 
template<class T >
static T * instance ()
 Get access to the singleton instance.
 
- Static Protected Member Functions inherited from Object
template<class T >
static T alias (const State *state)
 Create an alias object for the given state.
 
template<class T >
static T weak (const State *state)
 

Additional Inherited Members

- Public Types inherited from Object
using NullAccess = cc::NullAccess
 Error thrown when trying to access a null object.
 
using VirginityTestFailed = cc::VirginityTestFailed
 Error thrown when trying to initialize an object with a non-virgin state.
 
- Public Member Functions inherited from Object
 Object ()=default
 Create a null object.
 
 operator bool () const
 Check if this is a non-null object.
 
bool isNull () const
 Check if this is a null object.
 
int useCount () const
 Reference count.
 
template<class T >
bool is () const
 Check if this object is of type T.
 
template<class T >
as () const
 Cast this object to type T.
 
bool isWeak () const
 Check if the underlying object reference is weak.
 
bool operator== (const Object &other) const
 Equality operator.
 
std::strong_ordering operator<=> (const Object &other) const
 Ordering operator.
 
- Protected Attributes inherited from Object
Handle< Stateme
 Internal object state
 

Detailed Description

Process-wide singletons

See also
ThreadLocalSingleton, Object::initOnce(), Object::initOncePerThread(), global()

Constructor & Destructor Documentation

◆ Singleton() [1/2]

Singleton ( )
protecteddefault

Create a null singleton.

◆ Singleton() [2/2]

Singleton ( State state)
explicitprotected

Initialize singleton object with instance state.

Member Function Documentation

◆ instance()

template<class T >
static T * instance ( )
staticprotected

Get access to the singleton instance.