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

XML Based Communication library

, 18 Dec 2003
Rate this:
Please Sign up or sign in to vote.
XML based communication library to use command/object based through TCP/IP connections.

Introduction

The TCP/IP communication requires a lot of processing of incoming and outgoing data. The XML communication library uses XML streams to transfer data between the TCP/IP connections. The main idea is to use predefined communication objects. These communication objects can be serialized into XML streams. This XML stream, with a very small header to identify the serialized object and the XML size, can be used to communicate.

Background

XML communication library uses a straight forward idea:

  • Writing
    1. Define objects for each XML message wanted to be transferred.
    2. Serialize created object into XML stream.
    3. Determine the size of the generated XML stream.
    4. Construct communication header. I used a very simple header with the following format:
      CommandID:XML Stream Size:XML Stream String
    5. Write the constructed header/XML data to the network stream.
  • Reading
    1. Analyze incoming data for appropriate header (command ID, and XML data size)
    2. Use the header to read and deserialize into the appropriate object. This can be determined using the command ID.

This mechanism makes the communication more easier and more clear to code.

Using the code

The XML communication library is mainly based on one static class' operations. This class is called CommProtocol. This class defines a private default constructor to prevent any creation of objects for this class. This class has four static functions:

  1. Read: Reads data from network stream.
  2. Write: Writes data to network stream.
  3. ReadHeader: Reads incoming header from network stream. This function is used mainly by the Read function.
  4. ReadCommand: Deserialize the incoming XML stream to its appropriate object using the header information. This function is also mainly used by the Read function.

The following code describes how we can write to network stream using the CommProtocol class:

CommProtocol.Write(netStream,object,object type);

The Write function will take care of object serialization and header building, and writing to the network stream.

The following code describes how we can read from the network stream using the CommProtocol class:

object o = CommProtocol.Read(Networkstream,out cmd);
 switch(cmd) 
{ 
case /*your commands selector*/: 
/*Function to process the incoming object*/ 
break; 
}

The Read function will throw an exception if the network stream is closed or header is corrupted.

The XML serialized objects are defined in the library main file CommLib.cs. For the article code, I defined one class called CommSendText and one communication command called CommandSendText.

I developed the communication library mainly to help myself in the development of a server based chat application. The main issue I considered when I developed this library was to make the communication that simple. For this, I used double handshaking between the server and the clients. This means, each command sent to the server must return a status to the client. This makes the communication more reliable and up to date.

There are many enhancements I want to add to this library, so your feedback is very important to me.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Hesham Desouky
Architect Nebras Technology
Egypt Egypt
With a heavy C++/MFC background started my way to the DotNet and C# world.
Going from device drivers to standard windows applications development using C++/MFC since 1998, I started the switch to .Net technology in 2004.
Currently I am the Technical Development Manager and Software Architect of Nebras Technology (Medical Software Vendor) and one of its executives owners.

Comments and Discussions

 
SuggestionDemofile here! Working Communication. Pinmemberayeks13-May-13 23:47 
GeneralDemo Pinmemberacheoacheo19-Oct-10 4:39 
GeneralHelp [modified] Pinmembernintondo30-Nov-08 23:24 
any code sample I cant get a working app.. out of it =(
i tried James Bengard code gets nothing
 
modified on Monday, December 1, 2008 4:31 AM

GeneralRe: Help Pinmemberfabianse22-Apr-10 8:35 
GeneralHELP!!!! Pinmembertmn11418-Sep-06 12:29 
AnswerRe: HELP!!!! PinmemberHesham Desouky18-Sep-06 13:11 
QuestionReading more than one command at a time? PinmemberIkram Shaikh18-Nov-05 0:30 
AnswerRe: Reading more than one command at a time? PinmemberIkram Shaikh18-Nov-05 19:58 
GeneralProtocol Error, Header Corrupted PinmemberEclecticFrog13-Sep-04 10:45 
GeneralRe: Protocol Error, Header Corrupted PinmemberHesham Desuky17-Sep-04 7:49 
GeneralRe: Protocol Error, Header Corrupted PinmemberEclecticFrog25-Oct-04 16:55 
GeneralNew at C# with a couple questions... PinsussJames Bengard13-Jul-04 10:06 
GeneralRe: New at C# with a couple questions... PinmemberHesham Desuky14-Jul-04 11:24 
GeneralRe: New at C# with a couple questions... PinmemberJonathan Merriweather19-Aug-04 8:40 
GeneralRe: New at C# with a couple questions... PinmemberFocusedWolf30-Apr-05 15:04 
GeneralRe: New at C# with a couple questions... PinmemberHesham Desouky6-Jun-05 22:09 
GeneralRe: New at C# with a couple questions... Pinmemberacheoacheo19-Oct-10 5:11 
General"There is an error in XML document" PinmemberChimerique17-May-04 15:13 
GeneralRe: "There is an error in XML document" PinsussAnonymous17-May-04 21:34 
GeneralRe: "There is an error in XML document" PinmemberChimerique17-May-04 23:55 
GeneralRe: "There is an error in XML document" PinmemberChimerique18-May-04 0:06 
GeneralRe: "There is an error in XML document" PinmemberHesham Desuky5-Jun-04 22:30 
GeneralProblem in Using DLL in Visual C++ 6.0 PinmemberBeeAsif11-Nov-09 2:06 
GeneralRe: "There is an error in XML document" PinmemberHesham Desuky5-Jun-04 22:33 
GeneralRe: "There is an error in XML document" Pinmemberpinartekin17-Apr-07 5:11 
GeneralGood Pinmemberm a y s a m31-Dec-03 19:17 
GeneralRe: Good Pinsusshesham desouky12-Jan-04 23:41 
GeneralRe: Good Pinmemberh_Nebeway21-May-06 23:00 
GeneralFix the appearance PinmemberJonathan de Halleux19-Dec-03 4:23 
GeneralRe: Fix the appearance Pinmemberl a u r e n19-Dec-03 8:52 
GeneralRe: Fix the appearance PinmemberHesham Desokey19-Dec-03 23: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
Web04 | 2.8.141216.1 | Last Updated 19 Dec 2003
Article Copyright 2003 by Hesham Desouky
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid