Click here to Skip to main content
15,894,460 members
Articles / Programming Languages / C#

A Complete TCP Server/Client Communication and RMI Framework in C# .NET - Implementation

Rate me:
Please Sign up or sign in to vote.
4.91/5 (150 votes)
12 Jun 2011CPOL47 min read 1M   32.4K   348  
In this article, I will explain the implementation of an Open Source lightweight framework (named Simple Client Server Library (SCS)) that is developed to create client/server applications using a simple Remote Method Invocation mechanism over TCP/IP.
using System;
using System.IO;
using Hik.Samples.Scs.IrcChat.Arguments;

namespace Hik.Samples.Scs.IrcChat.Client
{
    /// <summary>
    /// This class is used to save and load preferences of the user.
    /// </summary>
    [Serializable]
    internal class UserPreferences
    {
        /// <summary>
        /// Gets the singleton instance of this class.
        /// </summary>
        public static UserPreferences Current
        {
            get
            {
                if (_current == null)
                {
                    lock (SyncObj)
                    {
                        if (_current == null)
                        {
                            _current = LoadPreferences();
                        }
                    }
                }

                return _current;
            }
        }

        /// <summary>
        /// Nick of the user.
        /// </summary>
        public string Nick { get; set; }

        /// <summary>
        /// Path of user's avatar file.
        /// </summary>
        public string AvatarFile { get; set; }

        /// <summary>
        /// Sound preference of user.
        /// True if sound is on.
        /// </summary>
        public bool IsSoundOn { get; set; }

        /// <summary>
        /// Ip address of the chat server.
        /// </summary>
        public string ServerIpAddress { get; set; }

        /// <summary>
        /// TCP port of the chat server.
        /// </summary>
        public int ServerTcpPort { get; set; }
        
        /// <summary>
        /// Text style of user.
        /// </summary>
        public MessageTextStyle TextStyle { get; private set; }

        /// <summary>
        /// The singleton instance of this class.
        /// </summary>
        private static UserPreferences _current;

        /// <summary>
        /// Used to synronize threads while creating singleton object.
        /// </summary>
        private static readonly object SyncObj = new object();

        /// <summary>
        /// Constructor.
        /// </summary>
        private UserPreferences()
        {
            IsSoundOn = true;
            TextStyle = new MessageTextStyle();
        }

        /// <summary>
        /// Saves preferences to the disc.
        /// </summary>
        public void Save()
        {
            try
            {
                ClientHelper.SerializeObjectToFile(
                    this, 
                    Path.Combine(ClientHelper.GetCurrentDirectory(), "Preferences.bin")
                    );
            }
            catch
            {
                
            }
        }

        /// <summary>
        /// Load last preferences from the disc.
        /// </summary>
        /// <returns>Last user preferences (or default values if not found)</returns>
        private static UserPreferences LoadPreferences()
        {
            try
            {
                var preferenceFile = Path.Combine(ClientHelper.GetCurrentDirectory(), "Preferences.bin");
                if (File.Exists(preferenceFile))
                {
                    return (UserPreferences)ClientHelper.DeserializeObjectFromFile(preferenceFile);
                }
            }
            catch
            {

            }

            return CreateDefault();
        }

        /// <summary>
        /// Creates a default-valued instance of this class.
        /// </summary>
        /// <returns>UserPreferences object with default values</returns>
        private static UserPreferences CreateDefault()
        {
            return new UserPreferences
                   {
                       Nick = "User Nick",
                       AvatarFile = Path.Combine(ClientHelper.GetCurrentDirectory(), @"Images\user_male.png"),
                       ServerIpAddress = "127.0.0.1",
                       ServerTcpPort = 10048
                   };
        }
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

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


Written By
Founder Volosoft
Turkey Turkey
I have started programming at 14 years old using Pascal as hobby. Then I interested in web development (HTML, JavaScript, ASP...) before university.

I graduated from Sakarya University Computer Engineering. At university, I learned C++, Visual Basic.NET, C#, ASP.NET and Java. I partly implemented ARP, IP and TCP protocols in Java as my final term project.

Now, I am working on Windows and web based software development mostly using Microsoft technologies in my own company.

My open source projects:

* ABP Framework: https://abp.io
* jTable: http://jtable.org
* Others: https://github.com/hikalkan

My personal web site:

https://halilibrahimkalkan.com

Comments and Discussions