juce::SingletonHolder< Type, MutexType, onlyCreateOncePerRun > Struct Template Reference

Used by the JUCE_DECLARE_SINGLETON macros to manage a static pointer to a singleton instance. More...

#include "juce_Singleton.h"

Inheritance diagram for juce::SingletonHolder< Type, MutexType, onlyCreateOncePerRun >:

Public Member Functions
Type *	get ()
	Returns the current instance, or creates a new instance if there isn't one.
Type *	getWithoutChecking ()
	Returns the current instance, or creates a new instance if there isn't one, but doesn't do any locking, or checking for recursion or error conditions.
void	deleteInstance ()
	Deletes and resets the current instance, if there is one.
void	clear (Type *expectedObject) noexcept
	Called by the class's destructor to clear the pointer if it is currently set to the given object.

Public Attributes
std::atomic< Type * >	instance

Detailed Description

template<typename Type, typename MutexType, bool onlyCreateOncePerRun>
struct juce::SingletonHolder< Type, MutexType, onlyCreateOncePerRun >

Used by the JUCE_DECLARE_SINGLETON macros to manage a static pointer to a singleton instance.

You generally won't use this directly, but see the macros JUCE_DECLARE_SINGLETON, JUCE_DECLARE_SINGLETON_SINGLETHREADED, JUCE_DECLARE_SINGLETON_SINGLETHREADED_MINIMAL, and JUCE_IMPLEMENT_SINGLETON for how it is intended to be used.

@tags{Core}

Definition at line 38 of file juce_Singleton.h.

Constructor & Destructor Documentation

~SingletonHolder()

template<typename Type , typename MutexType , bool onlyCreateOncePerRun>

juce::SingletonHolder< Type, MutexType, onlyCreateOncePerRun >::~SingletonHolder

(

)

Definition at line 42 of file juce_Singleton.h.

Member Function Documentation

clear()

template<typename Type , typename MutexType , bool onlyCreateOncePerRun>

void juce::SingletonHolder< Type, MutexType, onlyCreateOncePerRun >::clear ( Type *  expectedObject )

noexcept

Called by the class's destructor to clear the pointer if it is currently set to the given object.

Definition at line 116 of file juce_Singleton.h.

deleteInstance()

template<typename Type , typename MutexType , bool onlyCreateOncePerRun>

void juce::SingletonHolder< Type, MutexType, onlyCreateOncePerRun >::deleteInstance

(

)

Deletes and resets the current instance, if there is one.

Definition at line 109 of file juce_Singleton.h.

get()

template<typename Type , typename MutexType , bool onlyCreateOncePerRun>

Type * juce::SingletonHolder< Type, MutexType, onlyCreateOncePerRun >::get

(

)

Returns the current instance, or creates a new instance if there isn't one.

Definition at line 54 of file juce_Singleton.h.

getWithoutChecking()

template<typename Type , typename MutexType , bool onlyCreateOncePerRun>

Type * juce::SingletonHolder< Type, MutexType, onlyCreateOncePerRun >::getWithoutChecking

(

)

Returns the current instance, or creates a new instance if there isn't one, but doesn't do any locking, or checking for recursion or error conditions.

Definition at line 98 of file juce_Singleton.h.

Member Data Documentation

instance

template<typename Type , typename MutexType , bool onlyCreateOncePerRun>

std::atomic<Type*> juce::SingletonHolder< Type, MutexType, onlyCreateOncePerRun >::instance

Definition at line 123 of file juce_Singleton.h.

---

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

• juce_core/memory/juce_Singleton.h