Click here to Skip to main content
Click here to Skip to main content

Tagged as

Simple Singleton Pattern in C#

, 6 Jul 2011 CPOL
Rate this:
Please Sign up or sign in to vote.
A brief explaination of how to implement the Singleton pattern class in multithreading environment.
Often, a system only needs to create one instance of a class, and that instance will be accessed throughout the program. Examples would include objects needed for logging, communication, database access, etc.
 
So, if a system only needs one instance of a class, and that instance needs to be accessible in many different parts of a system, one control both instantiation and access by making that class a singleton.
 
A Singleton is the combination of two essential properties:
 
Ensure a class only has one instance.
Provide a global point of access to it.
 
You can find many articles on SingleTon Pattern but this article will give you an insight about the basics on SingleTon Pattern especially in the case of multithreading environment.
 

As stated above, a singleton is a class that can be instantiated once, and only once.
 
To achieve this we need to keep the following things in our mind.
 
1. Create a public Class (name SingleTonSample).
Collapse
 
public class SingleTonSample
{}
 
2. Define its constructor as private.
Collapse
 
private SingleTonSample()
{}
 
3. Create a private static instance of the class (name singleTonObject).
Collapse
 
private volatile static SingleTonSample singleTonObject;
 
4. Now write a static method (name InstanceCreation) which will be used to create an instance of this class and return it to the calling method.
Collapse
 
public static SingleTonSample InstanceCreation()
{
    private static object lockingObject = new object();
    if(singleTonObject == null)
    {
         lock (lockingObject)
         {
              if(singleTonObject == null)
              {
                   singleTonObject = new SingleTonSample();
              }
         }
    }
    return singleTonObject;
}
 
Now we to need to analyze this method in depth. We have created an instance of object named lockingObject, its role is to allow only one thread to access the code nested within the lock block at a time. So once a thread enter the lock area, other threads need to wait until the locking object get released so, even if multiple threads try to access this method and want to create an object simultaneously, it's not possible. Further only if the static instance of the class is null, a new instance of the class is allowed to be created.
 
Hence only one thread can create an instance of this Class because once an instance of this class is created the condition of singleTonObject being null is always false and therefore rest all instance will contain value null.
 
5. Create a public method in this class, for example I am creating a method to display message (name DisplayMessage), you can perform your actual task over here.
Collapse
 
public void DisplayMessage()
{
     Console.WriteLine("My First SingleTon Program");
}

 
6. Now we will create an another Class (name Program).
Collapse
 
class Program
{}
 
7. Create an entry point to the above class by having a method name Main.
Collapse
 
static void Main(string[] args)
{
    SingleTonSample singleton = SingleTonSample.InstanceCreation();
    singleton.DisplayMessage();
    Console.ReadLine();
}
 
Now we to need to analyse this method in depth. As we have created an instance singleton of the class SingleTonSample by calling the static method SingleTonSample.InstanceCreation() a new object gets created and hence further calling the method singleton.DisplayMessage() would give an output "My First SingleTon Program".

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Shashank Bisen
Software Developer (Senior) Icreon
India India
No Biography provided

Comments and Discussions

 
GeneralFine Pinmembervictowork2-Nov-14 23:51 
GeneralRated Excellent :) Pinmembersatheesh.palanisamy1-Dec-13 4:27 
QuestionMy vote of 4 PinmemberPeace ON20-Jul-13 1:50 
GeneralMy vote of 5 Pinmemberamirhosseineniac14-Mar-13 5:05 
QuestionThanks PinmemberVikramBansod9-Dec-12 8:22 
AnswerRe: Thanks Pinprofessional♥…ЯҠ…♥19-Mar-14 22:13 
GeneralAlternative 8 ends all discussion. Alternative 7 provides a ... PinmemberKabwla.Phone6-Nov-11 22:30 
GeneralI don't understand how do you asure that this's ThreadSafe. ... PinmemberLuchoStudio1-Nov-11 4:30 
GeneralReason for my vote of 1 Not the recommended way to implement... PinmemberRichard Deeming13-Jul-11 9:15 
GeneralLazy<T> is the Microsoft implementation of Singleton pattern... PinmemberMohammad A Rahman6-Jul-11 15:12 
GeneralReason for my vote of 1 As Piebald says: The lock is wrong, ... PinmemberErich Ledesma4-Jul-11 11:46 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.141223.1 | Last Updated 6 Jul 2011
Article Copyright 2011 by Shashank Bisen
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid