Main Page | See live article | Alphabetical index

Singleton pattern

In computer science, the singleton design pattern is designed to restrict instantiation of a class to one (or a few) objects. This is useful when exactly one object is needed to coordinate actions across the system. Sometimes it is generalized to systems that operate more efficiently when only one or a few objects exist.

The singleton pattern is implemented by creating a class with a method that creates a new instance of the object if one does not exist. If one does exist it returns a reference to the object that already exists. To make sure that the object cannot be instantiated any other way the constructor is made either private or protected.

The singleton pattern must be carefully constructed in multi-threaded applications. If both threads execute the creation method at the same time when a singleton does not yet exist, they both do a check for an instance of the singleton and then both create a new one.

The classic solution to this problem is to use mutual exclusion on the data that indicates that the object is already instantiated.

A Java programming language solution is as follows (see the Q&A link in external links):

public class Singleton { 

   private static final Singleton INSTANCE = new Singleton();

  // Private constructor suppresses 
  // default public constructor
   private Singleton() {}

   public static Singleton getInstance() {
       return INSTANCE;
   }
}

A possible C++ solution where the singleton is a static local object:

template class Singleton {

public: 

 static T& Instance()
 {
    if(!m_instance)
    {
       static T theSingleInstance;
       m_instance = &theSingleInstance;
    }
    return *m_instance;
 }
private: 
 static T* m_instance;
};

class OnlyOne : public Singleton { 

 //..rest of interface defined here
};

External Links