vpr::Singleton< singleClass > Class Template Reference

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

#include <vpr/Util/Singleton.h>

Inheritance diagram for vpr::Singleton< singleClass >:

[legend]List of all members.

Static Public Member Functions
static singleClass *	instance ()
	Note: Currently, this function is thread safe after first call to instance().
Protected Member Functions
	Singleton ()
	Don't create a singleton with new! use instance().
virtual	~Singleton ()
	don't delete a singleton!

---

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>

Parameters:

singleClass

The type to be used a singleton.

Note:

This class is currently broken under certain circumstances. Refer to SourceForge bug #'s 729485 and 929003. Until these bugs are fixed, use of the preprocessor macros vprSingletonHeader() et. al. are recommended.

Definition at line 117 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 153 of file Singleton.h.

      {
      }

template<class singleClass>

virtual vpr::Singleton< singleClass >::~Singleton

(

)

[inline, protected, virtual]

don't delete a singleton!

Definition at line 158 of file Singleton.h.

      {
      }

---

Member Function Documentation

template<class singleClass>

static singleClass* vpr::Singleton< singleClass >::instance

(

)

[inline, static]

Note:

Currently, this function 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 127 of file Singleton.h.

Referenced by vpr::InetAddrSIM::setAddress().

      {
         // 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

---