Click here to Skip to main content
11,505,158 members (68,827 online)
Click here to Skip to main content

A Simple Multi-Threaded Server Client Instant Messenger Application

, 4 Jun 2006 CPOL 111K 3.5K 107
Rate this:
Please Sign up or sign in to vote.
A Simple Multi-Threaded Server Client Instant Messenger Application that uses TCP Listener and TCP Client. Allows Personal message and Conference communication between Clients and with the Server
Sample Image - maximum width is 600 pixels

The Library Project

I created a ChatLibrary that will contain the valid commands and a Message that will contain the parsing.

public enum Command
{
   Login = 0,
   PersonalMessage = 1,    
   ClientList = 2,        
   Conference = 3,
   Logout = 4        
};

public class Message
{
string strSender;
string strReceiver;
Command cmdMessageCommand;
string strMessageDetail;
public Message ()
{
}
public Message (byte [] rawMessage)
{
  string strRawStringMessage = System.Text.Encoding.ASCII.GetString (rawMessage);   
  string [] strRawStringMessageArray = strRawStringMessage.Split(new char []{'|'});
  this.strSender = strRawStringMessageArray[1];
  this.strReceiver = strRawStringMessageArray[2];
  this.cmdMessageCommand = (Command) Convert.ToInt32(strRawStringMessageArray[3]);
  this.MessageDetail = strRawStringMessageArray[4];
}
...

public byte [] GetRawMessage ()
{
   System.Text.StringBuilder sbMessage = new System.Text.StringBuilder ("John");
   sbMessage.Append("|");
   sbMessage.Append(strSender);
   sbMessage.Append("|");
   sbMessage.Append(strReceiver);
   sbMessage.Append("|");
   sbMessage.Append((int)cmdMessageCommand);
   sbMessage.Append("|");
   sbMessage.Append(strMessageDetail);
   sbMessage.Append("|");
   return System.Text.Encoding.ASCII.GetBytes(sbMessage.ToString());
}
...

The Server Project

I created a SocketServer that calls the TCPListener.Start() method:

IPEndPoint endPoint = new IPEndPoint (ipaAddress, iPort);
listener = new TcpListener (endPoint);
listener.Start();

Upon calling Listen, a new thread will be created that will listen for incoming clients:

thrListenForClients = new Thread(new ThreadStart(ListenForClients));
thrListenForClients.Start();

The ListenForClients method will wait for connections and will assign the incoming socket to a new Client instance:

Client acceptClient = new Client();
acceptClient.Socket = listener.AcceptTcpClient();
listenForMessageDelegate = new ListenForMessageDelegate (ListenForMessages);
listenForMessageDelegate.BeginInvoke
    (acceptClient, new AsyncCallback(ListenForMessagesCallback), "Completed");

The Client, by the way is a class that contains a TCPClient, so we can keep track of our connections:

public class Client {
   string strName;
   TcpClient tcpClient;
   public Client()
   {
   }
   public string Name 
   {
    get{return strName;}
    set{ this.strName = value;}            
   }
   public TcpClient Socket
   {
    get{return tcpClient;}
    set{ this.tcpClient = value;}
   }
   public void SendMessage (Message sendMessage)
   {
    NetworkStream stream = tcpClient.GetStream();
    stream.Write(sendMessage.GetRawMessage() , 0, sendMessage.GetRawMessage().Length);            
   }
}

Our server is now ready to listen for incoming messages. To do this, we pass the client socket that we received, then make a loop. We use a NetworkStream to read the message:

NetworkStream stream = client.Socket.GetStream();
byte [] bytAcceptMessage = new byte [1024];
stream.Read(bytAcceptMessage, 0, bytAcceptMessage.Length);
Message message = new ChatLibrary.Message(bytAcceptMessage);

Once we receive the message, we can do anything that we want:

txtStatus.Text += "\r\n" + strDisplayMessageType + 
    strWriteText.TrimStart(new char[]{'\r','\n'});

My SocketServer makes use of a few events that make coding a little easier:

public event ClientConnectedEventHandler ClientConnected;
public event ClientDisconnectingEventHandler ClientDisconnecting;
public event MessageReceivedEventHandler MessageReceived;

In my ServerForm code, what I did was I kept a copy of each connected Client in a ClientCollection that inherits from System.Collections.CollectionBase. With this, I can iterate through the Clients.

The Client Project

The Client does basically the same thing. I created a ClientSocket that will create a TCPListener and call Connect():

IPEndPoint serverEndpoint = new IPEndPoint (ipaAddress , iPort);
tcpClient = new TcpClient ();
tcpClient.Connect(serverEndpoint);
thrListenForMessages = new Thread (new ThreadStart(ListenForMessages));
thrListenForMessages.Start();

What ListenForMessages will do is loop with NetworkStream.Read():

stream = tcpClient.GetStream();
byte [] bytRawMessage = new byte [1024];
stream.Read(bytRawMessage, 0, bytRawMessage.Length);
ChatMessage receivedMessage = new ChatLibrary.Message (bytRawMessage);

Then we do the same process, create a Message using the received bytes.

Again, my goal is to create a YM/MSN - looking Instant Messenger, so I made two UI forms. The MessengerForm and the ClientWindow. The MessengerForm is the class that instantiates the ClientSocket and receives the messages. Upon receiving a message, it calls the MessengerWindow that should display the text.

Note that I didn't do a regular instantiation. I called Invoke to be able to make my controls thread safe:

this.Invoke(createNewClientDelegate, new object []{receivedMessage});

History

  • 4th June 2006: Initial version

License

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

Share

About the Author

John Conrad
Web Developer
Philippines Philippines
John lives in the Philippines with his family, working as a programmer. He used to program VB6 but is now... ummm... trying to learn C# .Net.

Comments and Discussions

 
GeneralSystem.ObjectDisposedException after disconnect Pin
Gaara [BTK]15-Aug-07 14:22
memberGaara [BTK]15-Aug-07 14:22 
GeneralRe: System.ObjectDisposedException after disconnect Pin
Antbu1325-Oct-07 20:41
memberAntbu1325-Oct-07 20:41 
GeneralRe: System.ObjectDisposedException after disconnect Pin
EagleTwo20-May-09 10:43
memberEagleTwo20-May-09 10:43 
Generalproblem in running this application [modified] Pin
vrani12-Jul-07 19:38
membervrani12-Jul-07 19:38 
GeneralMulti-threading error fix Pin
stormist10-Jun-07 13:43
memberstormist10-Jun-07 13:43 
Generaltextbox Pin
dark_magician_65-May-07 4:50
memberdark_magician_65-May-07 4:50 
Questionnot working on lan plz help me Pin
Member #37941123-Mar-07 0:26
memberMember #37941123-Mar-07 0:26 
Questionit is working in LAN but what do i need to do for WAN ? Pin
evalenzuela2-Feb-07 11:57
memberevalenzuela2-Feb-07 11:57 
GeneralError Pin
Christian Siebmanns7-Oct-06 5:04
memberChristian Siebmanns7-Oct-06 5:04 
GeneralRe: Error Pin
bubbler_below9-Oct-06 17:09
memberbubbler_below9-Oct-06 17:09 
GeneralRe: Error Pin
bubbler_below10-Oct-06 22:25
memberbubbler_below10-Oct-06 22:25 
GeneralRe: Error Pin
Christian Siebmanns21-Oct-06 5:24
memberChristian Siebmanns21-Oct-06 5:24 
AnswerRe: Error Pin
duffer_0113-Apr-07 10:30
memberduffer_0113-Apr-07 10:30 
AnswerRe: Error Pin
@Jim13-Aug-07 10:06
member@Jim13-Aug-07 10:06 
GeneralRe: Error Pin
shnewaz20-Apr-08 6:55
membershnewaz20-Apr-08 6:55 
GeneralRe: Error Pin
marcoTDI13-May-08 21:47
membermarcoTDI13-May-08 21:47 
Generalhi Pin
ibless17-Aug-06 12:32
memberibless17-Aug-06 12:32 
GeneralRe: hi Pin
Christian Siebmanns21-Oct-06 5:07
memberChristian Siebmanns21-Oct-06 5:07 
Generalvery nice work Pin
Darchangel3-Aug-06 4:00
memberDarchangel3-Aug-06 4:00 
GeneralRe: very nice work Pin
shnewaz20-Apr-08 6:57
membershnewaz20-Apr-08 6:57 
GeneralRichtext Formatting Pin
Yadav Pramod26-Jul-06 21:54
memberYadav Pramod26-Jul-06 21:54 
GeneralRe: Richtext Formatting Pin
massivegas29-Jul-06 21:12
membermassivegas29-Jul-06 21:12 
GeneralGood application Pin
deepak_int18-Jun-06 19:28
memberdeepak_int18-Jun-06 19:28 
GeneralRe: Good application Pin
massivegas19-Jun-06 20:25
membermassivegas19-Jun-06 20:25 
GeneralIt works Pin
rduan12-Jun-06 9:04
memberrduan12-Jun-06 9:04 
GeneralYou got my 5 for... Pin
Jun Du5-Jun-06 4:18
memberJun Du5-Jun-06 4:18 
Generalhi Pin
nina0003-Mar-08 6:04
membernina0003-Mar-08 6:04 

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
Web03 | 2.8.150520.1 | Last Updated 5 Jun 2006
Article Copyright 2006 by John Conrad
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid