---

vpr::Singleton Class Template Reference

You can use this coolio class to make a singleton, just inherit like so... More...

#include <Singleton.h>

Inheritance diagram for vpr::Singleton:

[legend]List of all members.

Static Public Methods
singleClass *	instance (void)
	NOTE: currently, func is thread safe after first call to instance(). More...
Protected Methods
	Singleton ()
	Don't create a singleton with new! use instance(). More...
virtual	~Singleton ()
	don't delete a singleton! More...

---

Detailed Description

template<class singleClass>
class vpr::Singleton< singleClass >

You can use this coolio class to make a singleton, just inherit like so...

class myClass : public vpr::Singleton<myClass>

Definition at line 107 of file Singleton.h.

---

Constructor & Destructor Documentation

template<class singleClass> vpr::Singleton< singleClass >::Singleton (    )  [inline, protected]

Don't create a singleton with new! use instance(). Definition at line 141 of file Singleton.h. { }

template<class singleClass> virtual vpr::Singleton< singleClass >::~Singleton (    )  [inline, protected, virtual]

don't delete a singleton! Definition at line 146 of file Singleton.h. { }

---

Member Function Documentation

template<class singleClass> singleClass* vpr::Singleton< singleClass >::instance (  void    )  [inline, static]

NOTE: currently, func is thread safe after first call to instance(). if first call to instance happens multiple times simultaneously then don't be surprised when something dies because of a mutex.. this bug can be caused by spawning two threads immediately after entering main() Definition at line 117 of file Singleton.h. { // WARNING! race condition possibility, creation of static vars // are not thread safe. This is only an issue when creating // your first thread, since it uses a singleton thread manager, // the two threads might both try to call instance at the same time // which then the creation of the following mutex would not be certain. static vpr::Mutex singleton_lock1; static singleClass* the_instance1 = NULL; if (the_instance1 == NULL) { vpr::Guard<vpr::Mutex> guard( singleton_lock1 ); if (the_instance1 == NULL) { the_instance1 = new singleClass; } } return the_instance1; }

---

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

• Singleton.h

---