Click here to Skip to main content
15,887,746 members
Articles / Programming Languages / C#

Disconnected Client Architecture

Rate me:
Please Sign up or sign in to vote.
4.76/5 (65 votes)
14 Feb 2007CPOL22 min read 164.6K   2.7K   332  
A look at an offline client architecture that I've implemented in an application for a client.
/*
Copyright (c) 2007, Marc Clifton
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list
  of conditions and the following disclaimer. 

* Redistributions in binary form must reproduce the above copyright notice, this 
  list of conditions and the following disclaimer in the documentation and/or other
  materials provided with the distribution. 
 
* Neither the name of Marc Clifton nor the names of its contributors may be
  used to endorse or promote products derived from this software without specific
  prior written permission. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

using System;
using System.Data;

using Clifton.TcpLib;

using DCA.CommandPackets;

namespace DCA.ClientAPI
{
	/// <summary>
	/// Provides a concrete implementation for the ICommunications interface,
	/// wrapping the RCSConnectionService.
	/// </summary>
	public class Communications : ICommunications
	{
		protected RCSConnectionService conn;

		/// <summary>
		/// Constructor.
		/// </summary>
		/// <param name="conn">The RCSConnectionService instance.</param>
		public Communications(RCSConnectionService conn)
		{
			this.conn = conn;
		}

		/// <summary>
		/// Initializes the RCS stream for writing.
		/// </summary>
		public void BeginWrite()
		{
			conn.BeginWrite();
		}

		/// <summary>
		/// Closes the underlying RCS stream and writes the the packet
		/// out to the network stream.
		/// </summary>
		public void EndWrite()
		{
			conn.EndWrite();
		}

		/// <summary>
		/// Initializes the RCS stream for reading.  This reads the packet
		/// off of the network stream and prepares it for deserialization.
		/// </summary>
		public void BeginRead()
		{
			conn.BeginRead();
		}

		/// <summary>
		/// Closes the underlying RCS streams.
		/// </summary>
		public void EndRead()
		{
			conn.EndRead();
		}

		/// <summary>
		/// Reads a string.
		/// </summary>
		/// <returns>The string.</returns>
		public string ReadString()
		{
			return conn.ReadString();
		}

		/// <summary>
		/// Reads an object of the specified type.
		/// </summary>
		/// <param name="t">The type.</param>
		/// <returns>An object of the type.</returns>
		public object ReadData(Type t)
		{
			return conn.Read(t);
		}

		/// <summary>
		/// Reads a DataTable.
		/// </summary>
		/// <returns>The DataTable.</returns>
		public DataTable ReadDataTable()
		{
			return conn.ReadDataTable();
		}

		/// <summary>
		/// Reads a byte array.
		/// </summary>
		/// <returns>The byte array.</returns>
		public byte[] ReadByteArray()
		{
			return conn.ReadByteArray();
		}

		public bool ReadBool()
		{
			return conn.ReadBool();
		}

		/// <summary>
		/// Reads a Guid.
		/// </summary>
		/// <returns>The Guid.</returns>
		public Guid ReadGuid()
		{
			return conn.ReadGuid();
		}

		/// <summary>
		/// Reads an Int32.
		/// </summary>
		/// <returns>The Int32.</returns>
		public int ReadInt32()
		{
			return conn.ReadInt32();
		}

		/// <summary>
		/// Writes a string.
		/// </summary>
		/// <param name="str">The string.</param>
		public void Write(string str)
		{
			conn.WriteString(str);
		}

		/// <summary>
		/// Writes a boolean.
		/// </summary>
		/// <param name="b">The boolean.</param>
		public void Write(bool b)
		{
			conn.Write(b);
		}

		/// <summary>
		/// Writes an object.  The object may be a boxed value
		/// or a marshallable structure.
		/// </summary>
		/// <param name="data">The object.</param>
		public void WriteData(object data)
		{
			conn.Write(data);
		}

		/// <summary>
		/// Writes a DataTable.
		/// </summary>
		/// <param name="dt">The DataTable.</param>
		public void Write(DataTable dt)
		{
			conn.Write(dt);
		}

		/// <summary>
		/// Writes a byte array.
		/// </summary>
		/// <param name="data">The byte array.</param>
		public void Write(byte[] data)
		{
			conn.Write(data);
		}

		/// <summary>
		/// Writes a Guid.
		/// </summary>
		/// <param name="guid">The Guid.</param>
		public void Write(Guid guid)
		{
			conn.Write(guid);
		}

		/// <summary>
		/// Writes an Int32.
		/// </summary>
		/// <param name="i">The Int32.</param>
		public void Write(int i)
		{
			conn.Write(i);
		}
	}
}

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
Architect Interacx
United States United States
Blog: https://marcclifton.wordpress.com/
Home Page: http://www.marcclifton.com
Research: http://www.higherorderprogramming.com/
GitHub: https://github.com/cliftonm

All my life I have been passionate about architecture / software design, as this is the cornerstone to a maintainable and extensible application. As such, I have enjoyed exploring some crazy ideas and discovering that they are not so crazy after all. I also love writing about my ideas and seeing the community response. As a consultant, I've enjoyed working in a wide range of industries such as aerospace, boatyard management, remote sensing, emergency services / data management, and casino operations. I've done a variety of pro-bono work non-profit organizations related to nature conservancy, drug recovery and women's health.

Comments and Discussions